Skip to content

NetConnectAPI.md

Latest commit

 

History

History
269 lines (186 loc) · 12.1 KB

NetConnectAPI.md

File metadata and controls

269 lines (186 loc) · 12.1 KB
Raw

NetConnectAPI

All URIs are relative to https://app.corellium.com/api

Method HTTP request Description
NetConnectAPI_v3CreateNetworkConnection POST /v3/network/connections Create a new Network Connection
NetConnectAPI_v3DeleteNetworkConnection DELETE /v3/network/connections/{id} Delete an existing Network Connection
NetConnectAPI_v3GetNetworkConnection GET /v3/network/connections/{id} Fetch an existing Network Connection
NetConnectAPI_v3ListNetworkConnections GET /v3/network/connections List available network connections
NetConnectAPI_v3ListNetworkInterfaces GET /v3/network/interfaces List available physical network interfaces
NetConnectAPI_v3ListNetworkProviders GET /v3/network/providers List available network providers
NetConnectAPI_v3PartialUpdateNetworkConnection PATCH /v3/network/connections/{id} Update Network Connection (patch)
NetConnectAPI_v3UpdateNetworkConnection PUT /v3/network/connections/{id} Update Network Connection

NetConnectAPI_v3CreateNetworkConnection

// Create a new Network Connection
//
// Creates a network connection that projects can route their outbound device traffic through. Pick a provider type from `v3ListNetworkProviders` and supply its settings; for a VLAN, pick a physical interface from `v3ListNetworkInterfaces`. VLAN networks are only supported in bridged networking mode. Afterwards, attach it to a project by setting the project's `settings.connection`. You must have the domain administrator role to create a network connection.
//
list_t* NetConnectAPI_v3CreateNetworkConnection(apiClient_t *apiClient, object_t *body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
body object_t *

Return type

list_t *

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

NetConnectAPI_v3DeleteNetworkConnection

// Delete an existing Network Connection
//
// Delete an existing Network Connection. You must have the domain administrator role to delete a network connection.  Deletes are idempotent: an unknown `id`, or a connection that was already deleted, is a successful no-op that still returns 204, and repeated calls return 204 as well. A 404 means the request path did not match a delete route, not that the target was missing. A connection still attached to projects returns 400 unless `force` is set.
//
void NetConnectAPI_v3DeleteNetworkConnection(apiClient_t *apiClient, char *id, v3_delete_network_connection_request_t *v3_delete_network_connection_request);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
id char * Network Connection Identifier.
v3_delete_network_connection_request v3_delete_network_connection_request_t * [optional]

Return type

void

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

NetConnectAPI_v3GetNetworkConnection

// Fetch an existing Network Connection
//
// Returns one network connection: its settings and, for each project using it, the connection's current state there. A network connection routes a project's outbound device traffic through a network you control, such as a VPN or a VLAN. You must have the domain administrator or project administrator role to fetch a network connection.
//
object_t* NetConnectAPI_v3GetNetworkConnection(apiClient_t *apiClient, char *id);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
id char * Network Connection Identifier.

Return type

object_t *

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

NetConnectAPI_v3ListNetworkConnections

// List available network connections
//
// Lists the network connections set up in your domain. A network connection routes a project's outbound device traffic through a network you control, such as a VPN or a VLAN; a project uses one when its `settings.connection` is set to the connection's ID (see `PATCH /v3/projects/{projectId}`). You must have the domain administrator or project administrator role to list network connections.
//
network_connections_t* NetConnectAPI_v3ListNetworkConnections(apiClient_t *apiClient, double *limit, double *offset);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
limit double * Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400. [optional] [default to 100]
offset double * How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`. [optional] [default to 0]

Return type

network_connections_t *

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

NetConnectAPI_v3ListNetworkInterfaces

// List available physical network interfaces
//
// Lists the physical network ports on the server that can carry a VLAN network connection. Use one of these names when creating a VLAN connection. You must have the domain administrator role to list network interfaces.
//
network_interfaces_t* NetConnectAPI_v3ListNetworkInterfaces(apiClient_t *apiClient, double *limit, double *offset);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
limit double * Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400. [optional] [default to 100]
offset double * How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`. [optional] [default to 0]

Return type

network_interfaces_t *

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

NetConnectAPI_v3ListNetworkProviders

// List available network providers
//
// Provides a list of registered network providers to be used when creating network connections via [`createNetworkConnection`](#tag/netconnect/POST/v3/network/connections). You must have the domain administrator role to list network providers.
//
network_connection_providers_t* NetConnectAPI_v3ListNetworkProviders(apiClient_t *apiClient, double *limit, double *offset);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
limit double * Most results to return in one page. Whole number from 1 to 1000; defaults to 100. A value outside that range is rejected with 400. [optional] [default to 100]
offset double * How many results to skip before this page starts; defaults to 0. To get the next page, add `limit` to the previous `offset`. [optional] [default to 0]

Return type

network_connection_providers_t *

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

NetConnectAPI_v3PartialUpdateNetworkConnection

// Update Network Connection (patch)
//
// Only updates the specified attributes. You must have the domain administrator role to update a network connection.
//
object_t* NetConnectAPI_v3PartialUpdateNetworkConnection(apiClient_t *apiClient, char *id, partial_update_network_connection_body_t *partial_update_network_connection_body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
id char * Network Connection Identifier.
partial_update_network_connection_body partial_update_network_connection_body_t * [optional]

Return type

object_t *

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

NetConnectAPI_v3UpdateNetworkConnection

// Update Network Connection
//
// Replaces all of a network connection's settings. To change only some of them, use `v3PartialUpdateNetworkConnection`. You must have the domain administrator role to update a network connection.
//
object_t* NetConnectAPI_v3UpdateNetworkConnection(apiClient_t *apiClient, char *id, update_network_connection_body_t *update_network_connection_body);

Parameters

Name Type Description Notes
apiClient apiClient_t * context containing the client configuration
id char * Network Connection Identifier.
update_network_connection_body update_network_connection_body_t *

Return type

object_t *

Authorization

BearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]