API docs by Redocly

Stitched Network Asset Provisioning API (23.11.0)

Download OpenAPI specification:Download

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