Networks V1

Network operations V1

Get all Networks

Returns a list of all your networks

SecuritybasicAuth or bearerAuth
Request
query Parameters
page[number]
number

Current page based on pagination settings.

page[size]
number

Number of results to return per page based on pagination settings.

Responses
200

Successful response

Response Schema: application/json
Array of objects (Network)
object (Metadata)
401

Authentication error

Response Schema: application/json
Array of objects (Error Base)
Array
code
string

an application-specific error code, expressed as a stringified integer.

title
string

a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

detail
string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

pointer
string

JSON pointer to the field which is causing the error.

403

Authorization error

Response Schema: application/json
Array of objects (Error Base)
Array
code
string

an application-specific error code, expressed as a stringified integer.

title
string

a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.

detail
string

a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.

pointer
string

JSON pointer to the field which is causing the error.

get/networking/networks
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "id": 0,
      • "site_ids": [
        • "string"
        ],
      • "ip_address_count": 0,
      • "name": "string",
      • "record_type": "string",
      • "resource_group_id": "string",
      • "site_count": 0,
      • "transit_count": 0,
      • "transport_count": 0,
      • "vxc_count": 0
      }
    ],
  • "meta": {
    • "total_pages": 13,
    • "total_results": 13,
    • "page_number": 3,
    • "page_size": 1
    }
}
Create a Network
Create a new network.


SecuritybasicAuth or bearerAuth 
Request 
Request Body schema: application/json
required
name
required
string
Name of the network


 
resource_group_id
required
string
The id of the resource group the network is assigned to


 
site_ids
Array of strings
The list of site ids that you want to add to the network.


 
Responses 
200
Successful response


Response Schema: application/json
object (Network) 
 
id
required
number
The id of the network


 
site_ids
required
Array of strings
The list of site ids that have been added to the network.


 
ip_address_count
required
number
Number of IP addresses you have assigned to the network


 
name
required
string
Name of the network


 
record_type
required
string
The type of record being returned. This will always be network.


 
resource_group_id
required
string
The id of the resource group the network is assigned to


 
site_count
required
number
Number of sites this network spans


 
transit_count
required
number
Number of transit links you have in the network


 
transport_count
required
number
Number of transport links you have in the network


 
vxc_count
required
number
Number of VXCs you have in the network


 
401
Authentication error


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
403
Authorization error


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
422
Invalid parameters supplied in request. See HTTP response body for details.


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
post/networking/networks
Request samples 
application/json
{
  • "name": "string",
  • "resource_group_id": "string",
  • "site_ids": [
    • "string"
    ]
}
Response samples 
application/json
{
  • "data": {
    • "id": 0,
    • "site_ids": [
      • "string"
      ],
    • "ip_address_count": 0,
    • "name": "string",
    • "record_type": "string",
    • "resource_group_id": "string",
    • "site_count": 0,
    • "transit_count": 0,
    • "transport_count": 0,
    • "vxc_count": 0
    }
}
Get a Network
Returns the details of a network. The ID in the path can either be the name of the network (e.g. MYNETWORKPROD) or object ID.


SecuritybasicAuth or bearerAuth 
Request 
path Parameters
id
required
string
The id of the network


 
Responses 
200
Successful response


Response Schema: application/json
object (Network) 
 
id
required
number
The id of the network


 
site_ids
required
Array of strings
The list of site ids that have been added to the network.


 
ip_address_count
required
number
Number of IP addresses you have assigned to the network


 
name
required
string
Name of the network


 
record_type
required
string
The type of record being returned. This will always be network.


 
resource_group_id
required
string
The id of the resource group the network is assigned to


 
site_count
required
number
Number of sites this network spans


 
transit_count
required
number
Number of transit links you have in the network


 
transport_count
required
number
Number of transport links you have in the network


 
vxc_count
required
number
Number of VXCs you have in the network


 
401
Authentication error


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
403
Authorization error


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
404
Resource not found


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
get/networking/networks/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "id": 0,
    • "site_ids": [
      • "string"
      ],
    • "ip_address_count": 0,
    • "name": "string",
    • "record_type": "string",
    • "resource_group_id": "string",
    • "site_count": 0,
    • "transit_count": 0,
    • "transport_count": 0,
    • "vxc_count": 0
    }
}
Update a Network
Update the details of a network


SecuritybasicAuth or bearerAuth 
Request 
path Parameters
id
required
string
The id of the IP address


 
Request Body schema: application/json
resource_group_id
string
The id of the resource group the network is assigned to


 
site_ids
Array of strings
The list of site ids that you want to add to the network.


 
Responses 
200
Successful response


Response Schema: application/json
object (Network) 
 
id
required
number
The id of the network


 
site_ids
required
Array of strings
The list of site ids that have been added to the network.


 
ip_address_count
required
number
Number of IP addresses you have assigned to the network


 
name
required
string
Name of the network


 
record_type
required
string
The type of record being returned. This will always be network.


 
resource_group_id
required
string
The id of the resource group the network is assigned to


 
site_count
required
number
Number of sites this network spans


 
transit_count
required
number
Number of transit links you have in the network


 
transport_count
required
number
Number of transport links you have in the network


 
vxc_count
required
number
Number of VXCs you have in the network


 
401
Authentication error


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
403
Authorization error


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
422
Invalid parameters supplied in request. See HTTP response body for details.


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
patch/networking/networks/{id}
Request samples 
application/json
{
  • "resource_group_id": "string",
  • "site_ids": [
    • "string"
    ]
}
Response samples 
application/json
{
  • "data": {
    • "id": 0,
    • "site_ids": [
      • "string"
      ],
    • "ip_address_count": 0,
    • "name": "string",
    • "record_type": "string",
    • "resource_group_id": "string",
    • "site_count": 0,
    • "transit_count": 0,
    • "transport_count": 0,
    • "vxc_count": 0
    }
}
Delete a Network
Delete a network. The ID in the path can either be the name of the network (e.g. MYNETWORKPROD) or object ID.


SecuritybasicAuth or bearerAuth 
Request 
path Parameters
id
required
string
The id of the network


 
Responses 
200
Successful response


Response Schema: application/json
object (Network) 
 
id
required
number
The id of the network


 
site_ids
required
Array of strings
The list of site ids that have been added to the network.


 
ip_address_count
required
number
Number of IP addresses you have assigned to the network


 
name
required
string
Name of the network


 
record_type
required
string
The type of record being returned. This will always be network.


 
resource_group_id
required
string
The id of the resource group the network is assigned to


 
site_count
required
number
Number of sites this network spans


 
transit_count
required
number
Number of transit links you have in the network


 
transport_count
required
number
Number of transport links you have in the network


 
vxc_count
required
number
Number of VXCs you have in the network


 
401
Authentication error


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
403
Authorization error


Response Schema: application/json
Array of objects (Error Base) 
 
 Array 
code
string
an application-specific error code, expressed as a stringified integer.


 
title
string
a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization. Do not include punctuation in the title.


 
detail
string
a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.


 
pointer
string
JSON pointer to the field which is causing the error.


 
delete/networking/networks/{id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "id": 0,
    • "site_ids": [
      • "string"
      ],
    • "ip_address_count": 0,
    • "name": "string",
    • "record_type": "string",
    • "resource_group_id": "string",
    • "site_count": 0,
    • "transit_count": 0,
    • "transport_count": 0,
    • "vxc_count": 0
    }
}