Skip to main content

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.

Request

Path Parameters

    id stringrequired

    The id of the network

Responses

200: Successful response

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

401: Authentication error

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.

  • ]

403: Authorization error

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.

  • ]

404: Resource not found

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.

  • ]

Loading...