Get all Networks

GET 
/networking/networks

Returns a list of all your networks

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

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

id numberrequired

The id of the network

site_ids string[]required

The list of site ids that have been added to the network.

ip_address_count numberrequired

Number of IP addresses you have assigned to the network

name stringrequired

Name of the network

record_type stringrequired

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

resource_group_id stringrequired

The id of the resource group the network is assigned to

site_count numberrequired

Number of sites this network spans

transit_count numberrequired

Number of transit links you have in the network

transport_count numberrequired

Number of transport links you have in the network

vxc_count numberrequired

Number of VXCs you have in the network

]

meta

object

total_pages double

Total number of pages based on pagination settings

total_results double

Total number of results

page_number double

Current Page based on pagination settings (included when defaults are used.)

page_size double

Number of results to return per page based on pagination settings (included when defaults are used.)

{
  "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
  }
}

401: Authentication error

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

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.

]

{
  "errors": [
    {
      "code": "10001",
      "title": "error title",
      "detail": "additional detail about the error",
      "pointer": "/pointer/to/field"
    }
  ]
}

403: Authorization error

application/json

• Schema
• Example (from schema)

Schema

errors

object[]

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.

]

{
  "errors": [
    {
      "code": "10001",
      "title": "error title",
      "detail": "additional detail about the error",
      "pointer": "/pointer/to/field"
    }
  ]
}

Loading...