API docs by Redocly

Stitched Network Asset Provisioning API (25.02)

Download OpenAPI specification:

Stitched Network Asset Provisioning API

v1

Create a Network Asset

Create a Network Asset

header Parameters
X-Forwarded-Tenant-Id
required
string

IGNORED. This value is provided by proxy

Request Body schema:
object (AssetWithMOReference)

Responses

Request samples

Content type
{
  • "data": {
    }
}

Response samples

Content type
{
  • "data": {
    }
}

Get all Network Assets

Get all Network Assets

query Parameters
type
string
name
string

Accepts a regular expression

location
string
Example: location=latitude,longitude[,distance]
filterMetaData
string
Example: filterMetaData=city:Montreal,Ottawa#color:blue
pageSize
number
Example: pageSize=25
page
number
Example: page=10
graph
boolean

Returns a the asset with direct references or the full graph

header Parameters
X-Forwarded-Tenant-Id
required
string

IGNORED. This value is provided by proxy

Responses

Response samples

Content type
{
  • "data": [
    ]
}

Update a Network Asset

Update a Network Asset

path Parameters
id
required
string
header Parameters
X-Forwarded-Tenant-Id
required
string

IGNORED. This value is provided by proxy

Request Body schema:
object

Responses

Request samples

Content type
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Get a Network Asset

Get a Network Asset

path Parameters
id
required
string
query Parameters
graph
boolean

Returns a the asset with direct references or the full graph

header Parameters
X-Forwarded-Tenant-Id
required
string

IGNORED. This value is provided by proxy

Responses

Response samples

Content type
{
  • "data": {
    }
}

Delete a Network Asset

Delete a Network Asset

path Parameters
id
required
string
header Parameters
X-Forwarded-Tenant-Id
required
string

IGNORED. This value is provided by proxy

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Get Network Asset counts

Get Network Asset counts

query Parameters
type
string
name
string

Accepts a regular expression

location
string
Example: location=latitude,longitude[,distance]
filterMetaData
string
Example: filterMetaData=city:Montreal,Ottawa#color:blue
header Parameters
X-Forwarded-Tenant-Id
required
string

IGNORED. This value is provided by proxy

Responses

Response samples

Content type
{
  • "data": {
    }
}

Get flattened monitored object list ,matching network asset criteria

Get a flattened list of all monitored objects, belonging to a network asset which matches the query criteria

query Parameters
type
string
name
string

Accepts a regular expression

location
string
Example: location=latitude,longitude[,distance]
filterMetaData
string
Example: filterMetaData=city:Montreal,Ottawa#color:blue
circuitsPerPage
number
Example: circuitsPerPage=25
page
number
Example: page=10
header Parameters
X-Forwarded-Tenant-Id
required
string

IGNORED. This value is provided by proxy

Responses

Response samples

Content type
{
  • "data": [
    ]
}

Get unique monitored object types for given asset type

Returns a list of unique object types associated with the given network asset type

query Parameters
assetType
string

type of the asset. i.e.: circuit, node, etc

header Parameters
X-Forwarded-Tenant-Id
required
string

TenantID

Responses

Response samples

Content type
{
  • "data": [
    ]
}

Get Monitored Objects

Get Monitored Objects. Use query parameters to provide filters

query Parameters
objectName
string

Accepts a regular expression

objectId
string

Object Id

objectType
string
actuatorType
string
actuatorName
string
sourceLocation
string
Example: sourceLocation=latitude,longitude[,distance]
destinationLocation
string
Example: destinationLocation=latitude,longitude[,distance]
filterMetaData
string
Example: filterMetaData=city:Montreal,Ottawa#color:blue
pageSize
number
Example: pageSize=25
page
number
Example: page=10
header Parameters
X-Forwarded-Tenant-Id
required
string

IGNORED. This value is provided by proxy

Responses

Response samples

Content type
{
  • "data": [
    ]
}

Update a Monitored Object

Update a Monitored Object

path Parameters
uid
required
string
header Parameters
X-Forwarded-Tenant-Id
required
string

IGNORED. This value is provided by proxy

Request Body schema:
object

Responses

Request samples

Content type
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "errors": [
    ]
}

Get Monitored Objects

Get Monitored Objects. Use body to provide filters

header Parameters
X-Forwarded-Tenant-Id
required
string

IGNORED. This value is provided by proxy

Request Body schema:
required
object

Responses

Request samples

Content type
{
  • "data": {
    }
}

Response samples

Content type
{
  • "data": [
    ]
}

Returns a compact view of all Network Assets whose IDs are provided in the body

Returns a compact view of Network Assets

header Parameters
X-Forwarded-Tenant-Id
required
string

IGNORED. This value is provided by proxy

Request Body schema:
required
object

Responses

Request samples

Content type
{
  • "data": {
    }
}

Response samples

Content type
{
  • "data": [
    ]
}

Locations

Create a new Location in the network topology

Request Body schema: application/json
required
required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

List and search locations in the network topology

query Parameters
name
string

Partial match to the location's name (case insensitive)

page[size]
integer
Default: 10

The number of locations to return in the response

page[number]
integer
Default: 1

The page number for pagination

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "included": [
    ],
  • "links": {
    },
  • "meta": {
    }
}

Retrieve an existing location from the network topology

path Parameters
locationId
required
string <uuid>

The unique identifier of the location to retrieve

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

Delete an existing location from the network topology

path Parameters
locationId
required
string <uuid>

The unique identifier of the location to delete

Responses

Update an existing location in the network topology

path Parameters
locationId
required
string <uuid>

The unique identifier of the location to update

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    }
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "included": [
    ]
}

Nodes

Create a new node in the network topology

Request Body schema: application/json
required
name
required
string
ipv4
required
string
ipv6
required
string
required
object (Coordinates)
locationId
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "name": "LON",
  • "ipv4": "198.51.100.42",
  • "ipv6": "2001:0db8:5b96:0000:0000:426f:8e17:642a",
  • "geolocation": {
    },
  • "locationId": "d8d22fef-edac-4a4b-867d-0ce8b912f629"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "ACTIVE",
  • "ipv4": "192.168.0.1",
  • "ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
  • "name": "string",
  • "geolocation": {
    },
  • "location": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_modified": "2019-08-24T14:15:22Z"
}

Retrieve a list of nodes from the network topology with optional pagination and filtering

query Parameters
page
integer
Default: 1

Page number for pagination

limit
integer
Default: 10

Number of items per page for pagination

nodeId
string <uuid>

Optional filter for the unique identifier of the node

name
string

Optional filter for the node names starting with the provided prefix (case insensitive)

state
string
Enum: "ACTIVE" "ARCHIVED" "DELETING" "PROVISIONING"

Optional filter for the operational state of the node

Responses

Response samples

Content type
application/json
{
  • "nodes": [
    ],
  • "links": {
    },
  • "page": 0,
  • "limit": 0,
  • "total": 0
}

Retrieve an existing node from the network topology

path Parameters
nodeId
required
string <uuid>

The unique identifier of the node to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "ACTIVE",
  • "ipv4": "192.168.0.1",
  • "ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
  • "name": "string",
  • "geolocation": {
    },
  • "location": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_modified": "2019-08-24T14:15:22Z"
}

Update the status of an existing node Deprecated

path Parameters
nodeId
required
string <uuid>

Unique identifier for the node

Request Body schema: application/json
required
state
string
Enum: "ACTIVE" "ARCHIVED"

New status of the node

Responses

Request samples

Content type
application/json
{
  • "state": "ACTIVE"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "ACTIVE",
  • "ipv4": "192.168.0.1",
  • "ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
  • "name": "string",
  • "geolocation": {
    },
  • "location": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_modified": "2019-08-24T14:15:22Z"
}

Update the node

path Parameters
nodeId
required
string <uuid>

Unique identifier for the node

Request Body schema: application/json
required
ipv4
string <ipv4>

IPv4 address of the node

ipv6
string <ipv6>

IPv6 address of the node

object (Coordinates)
locationId
string <uuid>

New location of the node

Responses

Request samples

Content type
application/json
{
  • "ipv4": "192.168.0.1",
  • "ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
  • "geolocation": {
    },
  • "locationId": "d8d22fef-edac-4a4b-867d-0ce8b912f629"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "state": "ACTIVE",
  • "ipv4": "192.168.0.1",
  • "ipv6": "2001:0db8:85a3:0000:0000:8a2e:0370:7334",
  • "name": "string",
  • "geolocation": {
    },
  • "location": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_modified": "2019-08-24T14:15:22Z"
}

Delete an existing ARCHIVED node from the network topology

path Parameters
nodeId
required
string <uuid>

The unique identifier of the node to delete

Responses

Synchronize all nodes to Kafka

Responses

Synchronize a specific node to Kafka

path Parameters
nodeId
required
string <uuid>

The unique identifier of the node to retrieve

Responses

Segments

Retrieve an existing segment from the network topology

path Parameters
segmentId
required
string <uuid>

The unique identifier of the segment to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "state": "PROVISIONING",
  • "color": [
    ],
  • "node1": "b509793c-1580-4bb2-afd4-5dbfd197fea4",
  • "node2": "a434c6c8-a037-465a-aad6-064aac06bd02",
  • "orientations": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_modified": "2019-08-24T14:15:22Z"
}

Update the attributes of an existing segment

path Parameters
segmentId
required
string <uuid>

Unique identifier for the segment

Request Body schema: application/json
required
object or null

Key-value pairs to store additional information about the segment

Array of objects or null

List of colors associated with the segment

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "color": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "state": "PROVISIONING",
  • "color": [
    ],
  • "node1": "b509793c-1580-4bb2-afd4-5dbfd197fea4",
  • "node2": "a434c6c8-a037-465a-aad6-064aac06bd02",
  • "orientations": {
    },
  • "created_at": "2019-08-24T14:15:22Z",
  • "last_modified": "2019-08-24T14:15:22Z"
}

List segments with optional pagination and name filtering

query Parameters
page
integer
Default: 1

Page number for pagination

limit
integer
Default: 10

Number of items per page for pagination

name
string

Filter segments by name

state
string
Enum: "ACTIVE" "ARCHIVED" "DELETING" "PROVISIONING"

Optional filter for the operational state of the segment

Responses

Response samples

Content type
application/json
{
  • "segments": [
    ],
  • "links": {
    },
  • "page": 0,
  • "limit": 0,
  • "total": 0
}