Get a Network

GET 
/networking/networks/:id

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.

Path Parameters

id stringrequired

The id of the network

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

object

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

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

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

404: Resource not found

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

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/networking/networks/:id' \
-H 'Accept: application/json'

Response samples

• 200
• 401
• 403
• 404

---

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

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

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

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