logo

Networks

Endpoints for managing software-defined networks, for linking multiple environments together.

List Networks

Requires the sdn-networks-view capability.

SecuritybearerAuth and hubAuth
Request
query Parameters
include
Array of strings

A comma separated list of include values. Included resources will show up under the root document's include field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.

Items Enum: "creators" "environments"
object

Filter Field

The filter field is a key-value object, where the key is what you would like to filter, and the value is the value you're filtering for.

sort
Array of strings

An array of sort values. To sort descending, put a - in front of the value, e.g. -id.

object

In a list return, the data associated with the page number and size returned. 20 results per page, page 2 would be page[size]=20&page[number]=2

Responses
200

Returns a list of Networks.

default

General error response from the platform

get/v1/sdn/networks
Response samples
application/json
{
  • "data": [
    ],
  • "includes": {
    }
}

Create Network

Requires the sdn-networks-manage capability.

SecuritybearerAuth and hubAuth
Request
query Parameters
include
Array of strings

A comma separated list of include values. Included resources will show up under the root document's include field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.

Items Enum: "creators" "environments"
Request Body schema: application/json

Parameters for creating a new network.

name
required
string

The name of the network.

identifier
required
string

A network identifier used to construct http calls that specifically use this network over another.

ACL (object) or null
cluster
required
string

The infrastructure cluster the environments belonging to this network belong to.

environments
required
Array of strings

An array of environment Ids

Responses
201

Returns a network.

default

General error response from the platform

post/v1/sdn/networks
Request samples
application/json
{
  • "name": "string",
  • "identifier": "string",
  • "acl": {
    },
  • "cluster": "string",
  • "environments": [
    ]
}
Response samples
application/json
{
  • "data": {
    },
  • "includes": {
    }
}

Get Network

Requires the sdn-networks-view capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
networkId
required
string

The ID of the network.

query Parameters
include
Array of strings

A comma separated list of include values. Included resources will show up under the root document's include field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.

Items Enum: "creators" "environments"
Responses
200

Returns a Network.

default

General error response from the platform

get/v1/sdn/networks/{networkId}
Response samples
application/json
{
  • "data": {
    },
  • "includes": {
    }
}

Update Network

Requires the sdn-networks-manage capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
networkId
required
string

The ID of the Network.

query Parameters
include
Array of strings

A comma separated list of include values. Included resources will show up under the root document's include field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.

Items Enum: "creators" "environments"
Request Body schema: application/json

Parameters for updating a network.

name
string

The name of the network.

Responses
200

Returns a network.

default

General error response from the platform

patch/v1/sdn/networks/{networkId}
Request samples
application/json
{
  • "name": "string"
}
Response samples
application/json
{
  • "data": {
    },
  • "includes": {
    }
}

Delete Network

Requires the sdn-networks-manage capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
networkId
required
string

The ID of the network.

Responses
202

Returns a job descriptor.

default

General error response from the platform

delete/v1/sdn/networks/{networkId}
Response samples
application/json
{
  • "data": {
    }
}

Update Network Access

Requires the sdn-networks-manage capability. If an ACL is present, requires the manage privilege.

SecuritybearerAuth and hubAuth
Request
path Parameters
networkId
required
string

The ID of the Network.

query Parameters
include
Array of strings

A comma separated list of include values. Included resources will show up under the root document's include field, with the key being the id of the included resource. In the case of applying an include to a collection of resources, if two resources share the same include, it will only appear once in the return.

Items Enum: "creators" "environments"
Request Body schema: application/json

Parameters for updating a Network.

ACL (object) or null
Responses
200

Returns a Network.

default

General error response from the platform

patch/v1/sdn/networks/{networkId}/access
Request samples
application/json
{
  • "acl": {
    }
}
Response samples
application/json
{
  • "data": {
    },
  • "includes": {
    }
}

Create Network Job

Requires the sdn-networks-manage capability.

SecuritybearerAuth and hubAuth
Request
path Parameters
networkId
required
string

The ID of the Network.

Request Body schema: application/json

Parameters for creating a new Network Job.

action
required
string

The Job to do.

Value: "reconfigure"
required
object

Additional information needed for the Job.

Responses
202

Returns a Job Descriptor.

default

General error response from the platform

post/v1/sdn/networks/{networkId}/tasks
Request samples
application/json
{
  • "action": "reconfigure",
  • "contents": {
    }
}
Response samples
application/json
{
  • "data": {
    }
}
➔ Next to Search