REST API for SCC Sites and Uplinks v1.2

Resource: bandwidth_usage

Gives the bandwidth usage for LAN in and WAN out for sites based on start and end time.

http://{device}/api/cmc.topology/1.2/bandwidth_usage{?start_time,site_id,end_time}

JSON

{
  "start_time": integer,
  "end_time": integer,
  "total_lan": number,
  "total_wan": number,
  "data": [
    {
      "lan": number,
      "wan": number,
      "timestamp": integer
    }
  ]
}

{
  "start_time": integer,
  "end_time": integer,
  "total_lan": number,
  "total_wan": number,
  "data": [
    {
      "lan": number,
      "wan": number,
      "timestamp": integer
    }
  ]
}

Property Name	Type	Description	Notes
bandwidth_usage	<object>	Gives the bandwidth usage for LAN in and WAN out for sites based on start and end time.
bandwidth_usage.start_time	<integer>		Optional;
bandwidth_usage.end_time	<integer>		Optional;
bandwidth_usage.total_lan	<number>		Read-only; Optional;
bandwidth_usage.total_wan	<number>		Read-only; Optional;
bandwidth_usage.data	<array of <object>>		Optional;
bandwidth_usage.data[items]	<object>
bandwidth_usage.data[items].lan	<number>		Read-only; Optional;
bandwidth_usage.data[items].wan	<number>		Read-only; Optional;
bandwidth_usage.data[items].timestamp	<integer>		Read-only; Optional;

Links

bandwidth_usage: get

Get the bandwidth usage.

GET http://{device}/api/cmc.topology/1.2/bandwidth_usage{?start_time,site_id,end_time}

Response Body

Returns a bandwidth_usage data object.

Resource: uplink

Uplink object

http://{device}/api/cmc.topology/1.2/uplinks/items/{id}

JSON

{
  "id": identifier,
  "uplink_type_id": identifier,
  "uplink_type_name": string,
  "is_stc_uplink": boolean,
  "bandwidth_down": bandwidth_down,
  "bandwidth_up": bandwidth_up,
  "gateway_ip": ipv4address,
  "interface": interface,
  "nat": ipv4address,
  "probe_dscp": probe_dscp,
  "probe_timeout": probe_timeout,
  "probe_threshold": probe_threshold,
  "probing_bw": probing_bw,
  "is_firewalled": boolean,
  "is_default": boolean
}

{
  "id": identifier,
  "uplink_type_id": identifier,
  "uplink_type_name": string,
  "is_stc_uplink": boolean,
  "bandwidth_down": bandwidth_down,
  "bandwidth_up": bandwidth_up,
  "gateway_ip": ipv4address,
  "interface": interface,
  "nat": ipv4address,
  "probe_dscp": probe_dscp,
  "probe_timeout": probe_timeout,
  "probe_threshold": probe_threshold,
  "probing_bw": probing_bw,
  "is_firewalled": boolean,
  "is_default": boolean
}

Property Name	Type	Description	Notes
uplink	<object>	Uplink object	Required properties: [uplink_type_id, bandwidth_down, bandwidth_up, interface];
uplink.id	<identifier>	Generic numeric identifier	Read-only;
uplink.uplink_type_id	<identifier>	Generic numeric identifier	Read-only;
uplink_type_name	<string>	Case sensitive name. Only alphanumeric, '-' and '_' are permitted.	Read-only; Pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]*$\|^[a-zA-Z0-9_-][a-zA-Z0-9 _-]+[a-zA-Z0-9_-]$';
uplink.is_stc_uplink	<boolean>	Is this uplink used by the Secure transport concentrator?	Read-only; Optional;
uplink.bandwidth_down	<bandwidth_down>	Download Bandwidth, in kbps
uplink.bandwidth_up	<bandwidth_up>	Upload Bandwidth, in kbps
uplink.gateway_ip	<ipv4address>	IPv4 address (x.y.z.k)	Pattern: '^((?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?))?$';
uplink.interface	<interface>	In-path interface	Pattern: '^inpath\d_\d\|primary';
uplink.nat	<ipv4address>	IPv4 address (x.y.z.k)	Pattern: '^((?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?))?$';
uplink.probe_dscp	<probe_dscp>	DSCP Marking for path probe packets
uplink.probe_timeout	<probe_timeout>	Timeout in seconds, for path probe packets
uplink.probe_threshold	<probe_threshold>	Number of probes to detect a path as UP/DOWN
uplink.probing_bw	<probing_bw>	Probing bandwidth for this uplink in kbps
uplink.is_firewalled	<boolean>	Indicates whether the SteelHead accessing this Uplink is behind a firewall	Optional;
uplink.is_default	<boolean>	Indicates whether it is used as the interface default uplink	Optional;

Links

uplink: get

Retrieve the data representation of an uplink

GET http://{device}/api/cmc.topology/1.2/uplinks/items/{id}

Response Body

Returns an uplink data object.

Relations

uplink: instances

Related resource

uplinks

Resource: uplinks

List of Uplinks

http://{device}/api/cmc.topology/1.2/uplinks

JSON

[
  {
    "id": identifier,
    "uplink_type_id": identifier,
    "uplink_type_name": string,
    "is_stc_uplink": boolean,
    "bandwidth_down": bandwidth_down,
    "bandwidth_up": bandwidth_up,
    "gateway_ip": ipv4address,
    "interface": interface,
    "nat": ipv4address,
    "probe_dscp": probe_dscp,
    "probe_timeout": probe_timeout,
    "probe_threshold": probe_threshold,
    "probing_bw": probing_bw,
    "is_firewalled": boolean,
    "is_default": boolean
  }
]

[
  {
    "id": identifier,
    "uplink_type_id": identifier,
    "uplink_type_name": string,
    "is_stc_uplink": boolean,
    "bandwidth_down": bandwidth_down,
    "bandwidth_up": bandwidth_up,
    "gateway_ip": ipv4address,
    "interface": interface,
    "nat": ipv4address,
    "probe_dscp": probe_dscp,
    "probe_timeout": probe_timeout,
    "probe_threshold": probe_threshold,
    "probing_bw": probing_bw,
    "is_firewalled": boolean,
    "is_default": boolean
  }
]

Property Name	Type	Description	Notes
uplinks	<array of <items>>	List of Uplinks
items	<object>	Uplink object	Required properties: [uplink_type_id, bandwidth_down, bandwidth_up, interface];
items.id	<identifier>	Generic numeric identifier	Read-only;
items.uplink_type_id	<identifier>	Generic numeric identifier	Read-only;
uplink_type_name	<string>	Case sensitive name. Only alphanumeric, '-' and '_' are permitted.	Read-only; Pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]*$\|^[a-zA-Z0-9_-][a-zA-Z0-9 _-]+[a-zA-Z0-9_-]$';
items.is_stc_uplink	<boolean>	Is this uplink used by the Secure transport concentrator?	Read-only; Optional;
items.bandwidth_down	<bandwidth_down>	Download Bandwidth, in kbps
items.bandwidth_up	<bandwidth_up>	Upload Bandwidth, in kbps
items.gateway_ip	<ipv4address>	IPv4 address (x.y.z.k)	Pattern: '^((?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?))?$';
items.interface	<interface>	In-path interface	Pattern: '^inpath\d_\d\|primary';
items.nat	<ipv4address>	IPv4 address (x.y.z.k)	Pattern: '^((?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?))?$';
items.probe_dscp	<probe_dscp>	DSCP Marking for path probe packets
items.probe_timeout	<probe_timeout>	Timeout in seconds, for path probe packets
items.probe_threshold	<probe_threshold>	Number of probes to detect a path as UP/DOWN
items.probing_bw	<probing_bw>	Probing bandwidth for this uplink in kbps
items.is_firewalled	<boolean>	Indicates whether the SteelHead accessing this Uplink is behind a firewall	Optional;
items.is_default	<boolean>	Indicates whether it is used as the interface default uplink	Optional;

Links

uplinks: get

Get list of uplinks.

GET http://{device}/api/cmc.topology/1.2/uplinks

Response Body

Returns an uplinks data object.

Resource: site

Site object

http://{device}/api/cmc.topology/1.2/sites/items/{id}

JSON

{
  "id": identifier,
  "name": unrestricted_name,
  "site_type_id": identifier,
  "site_type_name": string,
  "region_id": identifier,
  "region_name": string,
  "description": string,
  "address": {
    "street": string,
    "city": string,
    "postal": string,
    "country": string
  },
  "contact": {
    "name": string,
    "title": string,
    "phone": string,
    "email": string
  },
  "status": string,
  "mission_critical": boolean,
  "is_secure_capable": boolean,
  "subnets": [ ipv4prefix ],
  "appliances": [ appliance ],
  "secure_transport_concentrators": [ secure_transport_concentrator ],
  "uplinks": [ site_uplink ],
  "is_backhaul_source": boolean,
  "is_backhaul_destination": boolean,
  "backhaul_destination_site_id": integer,
  "backhaul_source_site_ids": [ identifier ],
  "last_edited": integer,
  "peers": [ ipv4address ]
}

{
  "id": identifier,
  "name": unrestricted_name,
  "site_type_id": identifier,
  "site_type_name": string,
  "region_id": identifier,
  "region_name": string,
  "description": string,
  "address": {
    "street": string,
    "city": string,
    "postal": string,
    "country": string
  },
  "contact": {
    "name": string,
    "title": string,
    "phone": string,
    "email": string
  },
  "status": string,
  "mission_critical": boolean,
  "is_secure_capable": boolean,
  "subnets": [ ipv4prefix ],
  "appliances": [ appliance ],
  "secure_transport_concentrators": [ secure_transport_concentrator ],
  "uplinks": [ site_uplink ],
  "is_backhaul_source": boolean,
  "is_backhaul_destination": boolean,
  "backhaul_destination_site_id": integer,
  "backhaul_source_site_ids": [ identifier ],
  "last_edited": integer,
  "peers": [ ipv4address ]
}

Property Name	Type	Description	Notes
site	<object>	Site object	Required properties: [name, site_type_id, region_id, subnets];
site.id	<identifier>	Generic numeric identifier	Read-only;
site.name	<unrestricted_name>	Case sensitive name. Only alphanumeric, '-' and '_' are permitted.	Pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]*$\|^[a-zA-Z0-9_-][a-zA-Z0-9 _-]+[a-zA-Z0-9_-]$';
site.site_type_id	<identifier>	Generic numeric identifier	Read-only;
site.site_type_name	<string>		Read-only; Optional;
site.region_id	<identifier>	Generic numeric identifier	Read-only;
site.region_name	<string>		Read-only; Optional;
site.description	<string>		Optional;
site.address	<object>		Optional;
site.address.street	<string>		Optional;
site.address.city	<string>		Optional;
site.address.postal	<string>		Optional;
site.address.country	<string>		Optional;
site.contact	<object>		Optional;
site.contact.name	<string>		Optional;
site.contact.title	<string>		Optional;
site.contact.phone	<string>		Optional;
site.contact.email	<string>		Optional;
site.status	<string>		Read-only; Optional;
site.mission_critical	<boolean>		Optional;
site.is_secure_capable	<boolean>	Indicates secure capability by site associated uplinks	Read-only; Optional;
site.subnets	<array of <ipv4prefix>>
site.subnets[items]	<ipv4prefix>	IPv4 prefix (x.y.z.k/mask)	Pattern: '^(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)(/(3[012]\|[12]?[0-9]))$';
site.appliances	<array of <appliance>>	All appliances in this site except those which are secure transport only appliances.	Optional;
site.appliances[items]	<appliance>	Appliance Object
site.secure_transport_concentrators	<array of <secure_transport_concentrator>>	An array of secure transport concentrator's	Optional;
site.secure_transport_concentrators [items]	<secure_transport_concentrator>	A secure concentrator consists of a dedicated appliance with secure uplinks ..
site.uplinks	<array of <site_uplink>>	All uplinks at a site	Optional;
site.uplinks[items]	<site_uplink>	Uplink object
site.is_backhaul_source	<boolean>	Indicates if site backhauls to another site.	Read-only; Optional;
site.is_backhaul_destination	<boolean>	Indicates if this site is backhauled to from another site.	Read-only; Optional;
backhaul_destination_site_id	<integer>	Id of the site to which we are backhauling to.	Read-only; Minimum 1;
site.backhaul_source_site_ids	<array of <identifier>>	IDs of the site which backhauls to this site.	Read-only; Optional;
site.backhaul_source_site_ids[items]	<identifier>	Generic numeric identifier	Read-only;
site.last_edited	<integer>	Timestamp that indicates the last time this site was created or modified.	Optional;
site.peers	<array of <ipv4address>>		Optional;
site.peers[items]	<ipv4address>	IPv4 address (x.y.z.k)	Pattern: '^((?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?))?$';

Links

site: get

Retrieve the data representation of a site

GET http://{device}/api/cmc.topology/1.2/sites/items/{id}

Response Body

Returns a site data object.

site: set

Replace the data representation for a site

PUT http://{device}/api/cmc.topology/1.2/sites/items/{id}

Request Body

Provide a site data object.

Response Body

Returns a site data object.

site: delete

Delete a site instance

DELETE http://{device}/api/cmc.topology/1.2/sites/items/{id}

Response Body

On success, the server does not provide any body in the responses.

Relations

site: instances

Related resource

sites

Resource: brief_sites

List of Sites without the subnets

http://{device}/api/cmc.topology/1.2/brief_sites{?site_type_id,name,backhaul_destination_site_id,is_backhaul_destination,serial_number,is_backhaul_source,region_id}

JSON

[
  {
    "id": identifier,
    "name": unrestricted_name,
    "site_type_id": identifier,
    "site_type_name": string,
    "region_id": identifier,
    "region_name": string,
    "description": string,
    "address": {
      "street": string,
      "city": string,
      "postal": string,
      "country": string
    },
    "contact": {
      "name": string,
      "title": string,
      "phone": string,
      "email": string
    },
    "status": string,
    "mission_critical": boolean,
    "is_secure_capable": boolean,
    "appliances": [ appliance ],
    "secure_transport_concentrators": [ secure_transport_concentrator ],
    "uplinks_count": number,
    "stc_uplinks_count": number,
    "is_backhaul_source": boolean,
    "is_backhaul_destination": boolean,
    "backhaul_destination_site_id": integer,
    "backhaul_source_site_ids": [ identifier ],
    "last_edited": integer,
    <prop>: any
  }
]

[
  {
    "id": identifier,
    "name": unrestricted_name,
    "site_type_id": identifier,
    "site_type_name": string,
    "region_id": identifier,
    "region_name": string,
    "description": string,
    "address": {
      "street": string,
      "city": string,
      "postal": string,
      "country": string
    },
    "contact": {
      "name": string,
      "title": string,
      "phone": string,
      "email": string
    },
    "status": string,
    "mission_critical": boolean,
    "is_secure_capable": boolean,
    "appliances": [ appliance ],
    "secure_transport_concentrators": [ secure_transport_concentrator ],
    "uplinks_count": number,
    "stc_uplinks_count": number,
    "is_backhaul_source": boolean,
    "is_backhaul_destination": boolean,
    "backhaul_destination_site_id": integer,
    "backhaul_source_site_ids": [ identifier ],
    "last_edited": integer,
    <prop>: any
  }
]

Property Name	Type	Description	Notes
brief_sites	<array of <object>>	List of Sites without the subnets
brief_sites[items]	<object>
brief_sites[items].id	<identifier>	Generic numeric identifier	Read-only;
brief_sites[items].name	<unrestricted_name>	Case sensitive name. Only alphanumeric, '-' and '_' are permitted.	Pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]*$\|^[a-zA-Z0-9_-][a-zA-Z0-9 _-]+[a-zA-Z0-9_-]$';
brief_sites[items].site_type_id	<identifier>	Generic numeric identifier	Read-only;
brief_sites[items].site_type_name	<string>		Read-only; Optional;
brief_sites[items].region_id	<identifier>	Generic numeric identifier	Read-only;
brief_sites[items].region_name	<string>		Read-only; Optional;
brief_sites[items].description	<string>		Optional;
brief_sites[items].address	<object>		Optional;
brief_sites[items].address.street	<string>		Optional;
brief_sites[items].address.city	<string>		Optional;
brief_sites[items].address.postal	<string>		Optional;
brief_sites[items].address.country	<string>		Optional;
brief_sites[items].contact	<object>		Optional;
brief_sites[items].contact.name	<string>		Optional;
brief_sites[items].contact.title	<string>		Optional;
brief_sites[items].contact.phone	<string>		Optional;
brief_sites[items].contact.email	<string>		Optional;
brief_sites[items].status	<string>		Read-only; Optional;
brief_sites[items].mission_critical	<boolean>		Optional;
brief_sites[items].is_secure_capable	<boolean>	Indicates secure capability by site associated uplinks	Read-only; Optional;
brief_sites[items].appliances	<array of <appliance>>	All appliances in this site, except those which are secure transport only appliances	Optional;
brief_sites[items].appliances[items]	<appliance>	Appliance Object
brief_sites[items]. secure_transport_concentrators	<array of <secure_transport_concentrator>>	An array of secure transport concentrators	Optional;
brief_sites[items]. secure_transport_concentrators[items]	<secure_transport_concentrator>	A secure concentrator consists of a dedicated appliance with secure uplinks ..
brief_sites[items].uplinks_count	<number>	Count of uplinks at a site	Read-only; Optional;
brief_sites[items].stc_uplinks_count	<number>	Count of stc uplinks at a site	Read-only; Optional;
brief_sites[items].is_backhaul_source	<boolean>	Indicates if site backhauls to another site.	Read-only; Optional;
brief_sites[items]. is_backhaul_destination	<boolean>	Indicates if this site is backhauled to from another site.	Read-only; Optional;
backhaul_destination_site_id	<integer>	Id of the site to which we are backhauling to.	Read-only; Minimum 1;
brief_sites[items]. backhaul_source_site_ids	<array of <identifier>>	IDs of the site which backhauls to this site.	Read-only; Optional;
brief_sites[items]. backhaul_source_site_ids[items]	<identifier>	Generic numeric identifier	Read-only;
brief_sites[items].last_edited	<integer>	Timestamp that indicates the last time this site was created or modified.	Optional;
brief_sites[items].<prop>	<any>		Optional;

Links

brief_sites: get

Get list of sites.

GET http://{device}/api/cmc.topology/1.2/brief_sites{?site_type_id,name,backhaul_destination_site_id,is_backhaul_destination,serial_number,is_backhaul_source,region_id}

Response Body

Returns a brief_sites data object.

Resource: sites

List of Sites

http://{device}/api/cmc.topology/1.2/sites{?site_type_id,status,name,has_stc,backhaul_destination_site_id,is_backhaul_destination,serial_number,is_backhaul_source,region_id}

JSON

[
  {
    "id": identifier,
    "name": unrestricted_name,
    "site_type_id": identifier,
    "site_type_name": string,
    "region_id": identifier,
    "region_name": string,
    "description": string,
    "address": {
      "street": string,
      "city": string,
      "postal": string,
      "country": string
    },
    "contact": {
      "name": string,
      "title": string,
      "phone": string,
      "email": string
    },
    "status": string,
    "mission_critical": boolean,
    "is_secure_capable": boolean,
    "subnets": [ ipv4prefix ],
    "appliances": [ appliance ],
    "secure_transport_concentrators": [ secure_transport_concentrator ],
    "uplinks": [ site_uplink ],
    "is_backhaul_source": boolean,
    "is_backhaul_destination": boolean,
    "backhaul_destination_site_id": integer,
    "backhaul_source_site_ids": [ identifier ],
    "last_edited": integer,
    "peers": [ ipv4address ]
  }
]

[
  {
    "id": identifier,
    "name": unrestricted_name,
    "site_type_id": identifier,
    "site_type_name": string,
    "region_id": identifier,
    "region_name": string,
    "description": string,
    "address": {
      "street": string,
      "city": string,
      "postal": string,
      "country": string
    },
    "contact": {
      "name": string,
      "title": string,
      "phone": string,
      "email": string
    },
    "status": string,
    "mission_critical": boolean,
    "is_secure_capable": boolean,
    "subnets": [ ipv4prefix ],
    "appliances": [ appliance ],
    "secure_transport_concentrators": [ secure_transport_concentrator ],
    "uplinks": [ site_uplink ],
    "is_backhaul_source": boolean,
    "is_backhaul_destination": boolean,
    "backhaul_destination_site_id": integer,
    "backhaul_source_site_ids": [ identifier ],
    "last_edited": integer,
    "peers": [ ipv4address ]
  }
]

Property Name	Type	Description	Notes
sites	<array of <items>>	List of Sites
items	<object>	Site object	Required properties: [name, site_type_id, region_id, subnets];
items.id	<identifier>	Generic numeric identifier	Read-only;
items.name	<unrestricted_name>	Case sensitive name. Only alphanumeric, '-' and '_' are permitted.	Pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]*$\|^[a-zA-Z0-9_-][a-zA-Z0-9 _-]+[a-zA-Z0-9_-]$';
items.site_type_id	<identifier>	Generic numeric identifier	Read-only;
items.site_type_name	<string>		Read-only; Optional;
items.region_id	<identifier>	Generic numeric identifier	Read-only;
items.region_name	<string>		Read-only; Optional;
items.description	<string>		Optional;
items.address	<object>		Optional;
items.address.street	<string>		Optional;
items.address.city	<string>		Optional;
items.address.postal	<string>		Optional;
items.address.country	<string>		Optional;
items.contact	<object>		Optional;
items.contact.name	<string>		Optional;
items.contact.title	<string>		Optional;
items.contact.phone	<string>		Optional;
items.contact.email	<string>		Optional;
items.status	<string>		Read-only; Optional;
items.mission_critical	<boolean>		Optional;
items.is_secure_capable	<boolean>	Indicates secure capability by site associated uplinks	Read-only; Optional;
items.subnets	<array of <ipv4prefix>>
items.subnets[items]	<ipv4prefix>	IPv4 prefix (x.y.z.k/mask)	Pattern: '^(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)(/(3[012]\|[12]?[0-9]))$';
items.appliances	<array of <appliance>>	All appliances in this site except those which are secure transport only appliances.	Optional;
items.appliances[items]	<appliance>	Appliance Object
items.secure_transport_concentrators	<array of <secure_transport_concentrator>>	An array of secure transport concentrator's	Optional;
items.secure_transport_concentrators [items]	<secure_transport_concentrator>	A secure concentrator consists of a dedicated appliance with secure uplinks ..
items.uplinks	<array of <site_uplink>>	All uplinks at a site	Optional;
items.uplinks[items]	<site_uplink>	Uplink object
items.is_backhaul_source	<boolean>	Indicates if site backhauls to another site.	Read-only; Optional;
items.is_backhaul_destination	<boolean>	Indicates if this site is backhauled to from another site.	Read-only; Optional;
backhaul_destination_site_id	<integer>	Id of the site to which we are backhauling to.	Read-only; Minimum 1;
items.backhaul_source_site_ids	<array of <identifier>>	IDs of the site which backhauls to this site.	Read-only; Optional;
items.backhaul_source_site_ids[items]	<identifier>	Generic numeric identifier	Read-only;
items.last_edited	<integer>	Timestamp that indicates the last time this site was created or modified.	Optional;
items.peers	<array of <ipv4address>>		Optional;
items.peers[items]	<ipv4address>	IPv4 address (x.y.z.k)	Pattern: '^((?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?))?$';

Links

sites: get

Get list of sites.

GET http://{device}/api/cmc.topology/1.2/sites{?site_type_id,status,name,has_stc,backhaul_destination_site_id,is_backhaul_destination,serial_number,is_backhaul_source,region_id}

Response Body

Returns a sites data object.

sites: create

Create a new site instance

POST http://{device}/api/cmc.topology/1.2/sites{?site_type_id,status,name,has_stc,backhaul_destination_site_id,is_backhaul_destination,serial_number,is_backhaul_source,region_id}

Request Body

Provide a site data object.

Response Body

Returns a site data object.

sites: clear

Delete all site instances.

POST http://{device}/api/cmc.topology/1.2/sites/clear

Request Body

Do not provide a request body.

Response Body

On success, the server does not provide any body in the responses.

Resource: appliances

All appliances in sites

http://{device}/api/cmc.topology/1.2/sites/appliances{?secure_capable}

JSON

[ appliance ]

[ appliance ]

Property Name	Type	Description	Notes
appliances	<array of <appliance>>	All appliances in sites
appliances[items]	<appliance>	Appliance Object

Links

appliances: get

Retrieve the data representation of appliances

GET http://{device}/api/cmc.topology/1.2/sites/appliances{?secure_capable}

Response Body

Returns an appliances data object.

Resource: site_connectivity_template

Template of site connectivity parameters

http://{device}/api/cmc.topology/1.2/site_connectivity_templates/items/{id}

JSON

{
  "id": identifier,
  "name": unrestricted_name,
  "uplinks": [ uplink ]
}

{
  "id": identifier,
  "name": unrestricted_name,
  "uplinks": [ uplink ]
}

Property Name	Type	Description	Notes
site_connectivity_template	<object>	Template of site connectivity parameters	Required properties: [name];
site_connectivity_template.id	<identifier>	Generic numeric identifier	Read-only;
site_connectivity_template.name	<unrestricted_name>	Case sensitive name. Only alphanumeric, '-' and '_' are permitted.	Pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]*$\|^[a-zA-Z0-9_-][a-zA-Z0-9 _-]+[a-zA-Z0-9_-]$';
site_connectivity_template.uplinks	<array of <uplink>>	Site uplinks template	Optional;
site_connectivity_template.uplinks [items]	<uplink>	Uplink object

Links

site_connectivity_template: get

GET http://{device}/api/cmc.topology/1.2/site_connectivity_templates/items/{id}

Response Body

Returns a site_connectivity_template data object.

site_connectivity_template: set

PUT http://{device}/api/cmc.topology/1.2/site_connectivity_templates/items/{id}

Request Body

Provide a site_connectivity_template data object.

Response Body

Returns a site_connectivity_template data object.

site_connectivity_template: delete

DELETE http://{device}/api/cmc.topology/1.2/site_connectivity_templates/items/{id}

Response Body

On success, the server does not provide any body in the responses.

Relations

site_connectivity_template: instances

Related resource

site_connectivity_templates

Resource: site_connectivity_templates

http://{device}/api/cmc.topology/1.2/site_connectivity_templates

JSON

[ site_connectivity_template ]

[ site_connectivity_template ]

Property Name	Type	Description	Notes
site_connectivity_templates	<array of <site_connectivity_template>>
site_connectivity_templates[items]	<site_connectivity_template>	Template of site connectivity parameters

Links

site_connectivity_templates: create

POST http://{device}/api/cmc.topology/1.2/site_connectivity_templates

Request Body

Provide a site_connectivity_template data object.

Response Body

Returns a site_connectivity_template data object.

site_connectivity_templates: get

GET http://{device}/api/cmc.topology/1.2/site_connectivity_templates

Response Body

Returns a site_connectivity_templates data object.

site_connectivity_templates: clear

POST http://{device}/api/cmc.topology/1.2/site_connectivity_templates/clear

Request Body

Do not provide a request body.

Response Body

On success, the server does not provide any body in the responses.

Resource: network

Network object

http://{device}/api/cmc.topology/1.2/networks/items/{id}

JSON

{
  "id": integer,
  "name": string,
  "security_level": integer,
  "is_public": boolean,
  "probe_max_backoff": integer,
  "is_built_in": boolean
}

{
  "id": integer,
  "name": string,
  "security_level": integer,
  "is_public": boolean,
  "probe_max_backoff": integer,
  "is_built_in": boolean
}

Property Name	Type	Description	Notes
network	<object>	Network object	Required properties: [name];
id	<integer>	Network ID	Read-only; Minimum 1;
name	<string>	Network Name	Pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]*$\|^[a-zA-Z0-9_-][a-zA-Z0-9 _-]+[a-zA-Z0-9_-]$';
network.security_level	<integer>		Optional; Range: 0 to 1;
network.is_public	<boolean>		Optional;
network.probe_max_backoff	<integer>	Maximim probing backoff for this network	Optional; Range: 2 to 2592000;
network.is_built_in	<boolean>		Read-only; Optional;

Links

network: get

Retrieve a data representation of a Network

GET http://{device}/api/cmc.topology/1.2/networks/items/{id}

Response Body

Returns a network data object.

network: set

Replace the data representation for a Network

PUT http://{device}/api/cmc.topology/1.2/networks/items/{id}

Request Body

Provide a network data object.

Response Body

Returns a network data object.

network: delete

Delete a Network instance

DELETE http://{device}/api/cmc.topology/1.2/networks/items/{id}

Response Body

On success, the server does not provide any body in the responses.

Relations

network: instances

Related resource

networks

Resource: networks

List of Networks

http://{device}/api/cmc.topology/1.2/networks{?name}

JSON

[ network ]

[ network ]

Property Name	Type	Description	Notes
networks	<array of <network>>	List of Networks
networks[items]	<network>	Network object

Links

networks: create

Create a new Network instance

POST http://{device}/api/cmc.topology/1.2/networks{?name}

Request Body

Provide a network data object.

Response Body

Returns a network data object.

networks: get

Get a list of Network instances.

GET http://{device}/api/cmc.topology/1.2/networks{?name}

Response Body

Returns a networks data object.

networks: clear

Delete all the Network instances.

POST http://{device}/api/cmc.topology/1.2/networks/clear

Request Body

Do not provide a request body.

Response Body

On success, the server does not provide any body in the responses.

Resource: uplink_type

Type of uplinks for path selection

http://{device}/api/cmc.topology/1.2/uplink_types/items/{id}

JSON

{
  "id": identifier,
  "name": unrestricted_name,
  "network_id": identifier,
  "network_name": string
}

{
  "id": identifier,
  "name": unrestricted_name,
  "network_id": identifier,
  "network_name": string
}

Property Name	Type	Description	Notes
uplink_type	<object>	Type of uplinks for path selection	Required properties: [name, network_id];
uplink_type.id	<identifier>	Generic numeric identifier	Read-only;
uplink_type.name	<unrestricted_name>	Case sensitive name. Only alphanumeric, '-' and '_' are permitted.	Pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]*$\|^[a-zA-Z0-9_-][a-zA-Z0-9 _-]+[a-zA-Z0-9_-]$';
uplink_type.network_id	<identifier>	Generic numeric identifier	Read-only;
network_name	<string>	Case sensitive name. Only alphanumeric, '-' and '_' are permitted.	Read-only; Pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]*$\|^[a-zA-Z0-9_-][a-zA-Z0-9 _-]+[a-zA-Z0-9_-]$';

Links

uplink_type: get

GET http://{device}/api/cmc.topology/1.2/uplink_types/items/{id}

Response Body

Returns an uplink_type data object.

uplink_type: set

PUT http://{device}/api/cmc.topology/1.2/uplink_types/items/{id}

Request Body

Provide an uplink_type data object.

Response Body

Returns an uplink_type data object.

uplink_type: delete

DELETE http://{device}/api/cmc.topology/1.2/uplink_types/items/{id}

Response Body

On success, the server does not provide any body in the responses.

Relations

uplink_type: instances

Related resource

uplink_types

uplink_type: network

Related resource

network

Variables

Related var	Data value for replacement
id	0/network_id

Resource: uplink_types

List of uplink types

http://{device}/api/cmc.topology/1.2/uplink_types{?network_id,name}

JSON

[ uplink_type ]

[ uplink_type ]

Property Name	Type	Description	Notes
uplink_types	<array of <uplink_type>>	List of uplink types
uplink_types[items]	<uplink_type>	Type of uplinks for path selection

Links

uplink_types: create

POST http://{device}/api/cmc.topology/1.2/uplink_types{?network_id,name}

Request Body

Provide an uplink_type data object.

Response Body

Returns an uplink_type data object.

uplink_types: get

GET http://{device}/api/cmc.topology/1.2/uplink_types{?network_id,name}

Response Body

Returns an uplink_types data object.

uplink_types: clear

POST http://{device}/api/cmc.topology/1.2/uplink_types/clear

Request Body

Do not provide a request body.

Response Body

On success, the server does not provide any body in the responses.

Resource: site_type

Type of category and function of the site

http://{device}/api/cmc.topology/1.2/site_types/items/{id}

JSON

{
  "id": identifier,
  "name": unrestricted_name,
  "description": string,
  "is_built_in": boolean
}

{
  "id": identifier,
  "name": unrestricted_name,
  "description": string,
  "is_built_in": boolean
}

Property Name	Type	Description	Notes
site_type	<object>	Type of category and function of the site	Required properties: [name];
site_type.id	<identifier>	Generic numeric identifier	Read-only;
site_type.name	<unrestricted_name>	Case sensitive name. Only alphanumeric, '-' and '_' are permitted.	Pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]*$\|^[a-zA-Z0-9_-][a-zA-Z0-9 _-]+[a-zA-Z0-9_-]$';
site_type.description	<string>		Optional;
site_type.is_built_in	<boolean>		Read-only; Optional;

Links

site_type: get

GET http://{device}/api/cmc.topology/1.2/site_types/items/{id}

Response Body

Returns a site_type data object.

site_type: set

PUT http://{device}/api/cmc.topology/1.2/site_types/items/{id}

Request Body

Provide a site_type data object.

Response Body

Returns a site_type data object.

site_type: delete

DELETE http://{device}/api/cmc.topology/1.2/site_types/items/{id}

Response Body

On success, the server does not provide any body in the responses.

Relations

site_type: instances

Related resource

site_types

Resource: site_types

List of site types

http://{device}/api/cmc.topology/1.2/site_types{?name}

JSON

[
  {
    "id": identifier,
    "name": unrestricted_name,
    "description": string,
    "is_built_in": boolean,
    <prop>: any
  }
]

[
  {
    "id": identifier,
    "name": unrestricted_name,
    "description": string,
    "is_built_in": boolean,
    <prop>: any
  }
]

Property Name	Type	Description	Notes
site_types	<array of <object>>	List of site types
site_types[items]	<object>
site_types[items].id	<identifier>	Generic numeric identifier	Read-only;
site_types[items].name	<unrestricted_name>	Case sensitive name. Only alphanumeric, '-' and '_' are permitted.	Pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]*$\|^[a-zA-Z0-9_-][a-zA-Z0-9 _-]+[a-zA-Z0-9_-]$';
site_types[items].description	<string>		Optional;
site_types[items].is_built_in	<boolean>		Read-only; Optional;
site_types[items].<prop>	<any>		Optional;

Links

site_types: create

POST http://{device}/api/cmc.topology/1.2/site_types{?name}

Request Body

Provide a site_type data object.

Response Body

Returns a site_type data object.

site_types: get

GET http://{device}/api/cmc.topology/1.2/site_types{?name}

Response Body

Returns a site_types data object.

site_types: clear

POST http://{device}/api/cmc.topology/1.2/site_types/clear

Request Body

Do not provide a request body.

Response Body

On success, the server does not provide any body in the responses.

Resource: site_type_stats

Get the status for a site.

http://{device}/api/cmc.topology/1.2/site_types/items/{site_type_id}/stats{?start_time,end_time}

JSON

{
  "site_type_id": integer,
  "start_time": integer,
  "end_time": integer,
  "status": string,
  "normal_status_count": integer,
  "critical_status_count": integer,
  "warning_status_count": integer
}

{
  "site_type_id": integer,
  "start_time": integer,
  "end_time": integer,
  "status": string,
  "normal_status_count": integer,
  "critical_status_count": integer,
  "warning_status_count": integer
}

Property Name	Type	Description	Notes
site_type_stats	<object>	Get the status for a site.
site_type_stats.site_type_id	<integer>		Optional;
site_type_stats.start_time	<integer>		Optional;
site_type_stats.end_time	<integer>		Optional;
site_type_stats.status	<string>		Read-only; Optional;
site_type_stats.normal_status_count	<integer>		Read-only; Optional;
site_type_stats.critical_status_count	<integer>		Read-only; Optional;
site_type_stats.warning_status_count	<integer>		Read-only; Optional;

Links

site_type_stats: get

GET http://{device}/api/cmc.topology/1.2/site_types/items/{site_type_id}/stats{?start_time,end_time}

Response Body

Returns a site_type_stats data object.

Resource: region

Physical region of the property

http://{device}/api/cmc.topology/1.2/regions/items/{id}

JSON

{
  "id": identifier,
  "name": unrestricted_name
}

{
  "id": identifier,
  "name": unrestricted_name
}

Property Name	Type	Description	Notes
region	<object>	Physical region of the property	Required properties: [name];
region.id	<identifier>	Generic numeric identifier	Read-only;
region.name	<unrestricted_name>	Case sensitive name. Only alphanumeric, '-' and '_' are permitted.	Pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]*$\|^[a-zA-Z0-9_-][a-zA-Z0-9 _-]+[a-zA-Z0-9_-]$';

Links

region: get

GET http://{device}/api/cmc.topology/1.2/regions/items/{id}

Response Body

Returns a region data object.

region: set

PUT http://{device}/api/cmc.topology/1.2/regions/items/{id}

Request Body

Provide a region data object.

Response Body

Returns a region data object.

region: delete

DELETE http://{device}/api/cmc.topology/1.2/regions/items/{id}

Response Body

On success, the server does not provide any body in the responses.

Relations

region: instances

Related resource

regions

Resource: regions

List of regions

http://{device}/api/cmc.topology/1.2/regions{?name}

JSON

[ region ]

[ region ]

Property Name	Type	Description	Notes
regions	<array of <region>>	List of regions
regions[items]	<region>	Physical region of the property

Links

regions: create

POST http://{device}/api/cmc.topology/1.2/regions{?name}

Request Body

Provide a region data object.

Response Body

Returns a region data object.

regions: get

GET http://{device}/api/cmc.topology/1.2/regions{?name}

Response Body

Returns a regions data object.

regions: clear

POST http://{device}/api/cmc.topology/1.2/regions/clear

Request Body

Do not provide a request body.

Response Body

On success, the server does not provide any body in the responses.

Resource: uplink_status

Read only detailed description of the status of uplink.

http://{device}/api/cmc.topology/1.2/uplink_status{?site_type_id,site_id}

JSON

[
  {
    "site_type_id": identifier,
    "site_type_path_status": [
      {
        "path_status": string,
        "path_count": number,
        "site_count": number
      }
    ],
    "site_type_details": [
      {
        "site_id": identifier,
        "uplink_status": [
          {
            "id": identifier,
            "status": string
          }
        ],
        "site_reachability_status": [
          {
            "site_name": string,
            "reachability_status": string
          }
        ],
        "path_status": [
          {
            "path_status": string,
            "path_count": number
          }
        ],
        "appliances": [
          {
            "serialnum": identifier,
            "uplinks": [
              {
                "uplink_name": string,
                "remote_sites": [
                  {
                    "remote_site_name": string,
                    "peers": [
                      {
                        "peer_ip": string,
                        "peer_status": ipv4address
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
]

[
  {
    "site_type_id": identifier,
    "site_type_path_status": [
      {
        "path_status": string,
        "path_count": number,
        "site_count": number
      }
    ],
    "site_type_details": [
      {
        "site_id": identifier,
        "uplink_status": [
          {
            "id": identifier,
            "status": string
          }
        ],
        "site_reachability_status": [
          {
            "site_name": string,
            "reachability_status": string
          }
        ],
        "path_status": [
          {
            "path_status": string,
            "path_count": number
          }
        ],
        "appliances": [
          {
            "serialnum": identifier,
            "uplinks": [
              {
                "uplink_name": string,
                "remote_sites": [
                  {
                    "remote_site_name": string,
                    "peers": [
                      {
                        "peer_ip": string,
                        "peer_status": ipv4address
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
]

Property Name	Type	Description	Notes
uplink_status	<array of <object>>	Read only detailed description of the status of uplink.
uplink_status[items]	<object>
uplink_status[items].site_type_id	<identifier>	Generic numeric identifier	Read-only;
uplink_status[items]. site_type_path_status	<array of <object>>		Optional;
uplink_status[items]. site_type_path_status[items]	<object>
uplink_status[items]. site_type_path_status[items]. path_status	<string>		Optional;
uplink_status[items]. site_type_path_status[items]. path_count	<number>	The number of paths that have this path_status from the current site_type.	Optional;
uplink_status[items]. site_type_path_status[items]. site_count	<number>	The number of sites that have this path_status from the current site_type.	Optional;
uplink_status[items].site_type_details	<array of <object>>		Optional;
uplink_status[items].site_type_details [items]	<object>
uplink_status[items].site_type_details [items].site_id	<identifier>	Generic numeric identifier	Read-only;
uplink_status[items].site_type_details [items].uplink_status	<array of <object>>		Optional;
uplink_status[items].site_type_details [items].uplink_status[items]	<object>
uplink_status[items].site_type_details [items].uplink_status[items].id	<identifier>	Generic numeric identifier	Read-only;
uplink_status[items].site_type_details [items].uplink_status[items].status	<string>		Optional;
uplink_status[items].site_type_details [items].site_reachability_status	<array of <object>>		Optional;
uplink_status[items].site_type_details [items].site_reachability_status [items]	<object>
uplink_status[items].site_type_details [items].site_reachability_status [items].site_name	<string>		Optional;
uplink_status[items].site_type_details [items].site_reachability_status [items].reachability_status	<string>		Optional;
uplink_status[items].site_type_details [items].path_status	<array of <object>>		Optional;
uplink_status[items].site_type_details [items].path_status[items]	<object>
uplink_status[items].site_type_details [items].path_status[items].path_status	<string>		Optional;
uplink_status[items].site_type_details [items].path_status[items].path_count	<number>		Optional;
uplink_status[items].site_type_details [items].appliances	<array of <object>>		Optional;
uplink_status[items].site_type_details [items].appliances[items]	<object>
uplink_status[items].site_type_details [items].appliances[items].serialnum	<identifier>	Generic numeric identifier	Read-only;
uplink_status[items].site_type_details [items].appliances[items].uplinks	<array of <object>>		Optional;
uplink_status[items].site_type_details [items].appliances[items].uplinks [items]	<object>
uplink_status[items].site_type_details [items].appliances[items].uplinks [items].uplink_name	<string>		Optional;
uplink_status[items].site_type_details [items].appliances[items].uplinks [items].remote_sites	<array of <object>>		Optional;
uplink_status[items].site_type_details [items].appliances[items].uplinks [items].remote_sites[items]	<object>
uplink_status[items].site_type_details [items].appliances[items].uplinks [items].remote_sites[items]. remote_site_name	<string>		Optional;
uplink_status[items].site_type_details [items].appliances[items].uplinks [items].remote_sites[items].peers	<array of <object>>		Optional;
uplink_status[items].site_type_details [items].appliances[items].uplinks [items].remote_sites[items].peers [items]	<object>
uplink_status[items].site_type_details [items].appliances[items].uplinks [items].remote_sites[items].peers [items].peer_ip	<string>		Optional;
uplink_status[items].site_type_details [items].appliances[items].uplinks [items].remote_sites[items].peers [items].peer_status	<ipv4address>	IPv4 address (x.y.z.k)	Pattern: '^((?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?))?$';

Links

uplink_status: get

Get the uplink_status.

GET http://{device}/api/cmc.topology/1.2/uplink_status{?site_type_id,site_id}

Response Body

Returns an uplink_status data object.

Resource: appliance_site_uplink

Uplinks info of the site which has the input appliance

http://{device}/api/cmc.topology/1.2/appliance_site_uplink{?name}

JSON

[ site_uplink ]

[ site_uplink ]

Property Name	Type	Description	Notes
appliance_site_uplink	<array of <site_uplink>>	Uplinks info of the site which has the input appliance
appliance_site_uplink[items]	<site_uplink>	Uplink object

Links

appliance_site_uplink: get

Retrieve uplink info of the appliance

GET http://{device}/api/cmc.topology/1.2/appliance_site_uplink{?name}

Response Body

Returns an appliance_site_uplink data object.

Resource: poller

Callback for polled requests to the appliance

http://{device}/api/cmc.topology/1.2/poller_callback

JSON

{
  <prop>: any
}

{
  <prop>: any
}

Property Name	Type	Description	Notes
poller	<object>	Callback for polled requests to the appliance
poller.<prop>	<any>		Optional;

Links

poller: callback

Callback to get polled response

POST http://{device}/api/cmc.topology/1.2/poller_callback

Request Body

Provide a poller_response data object.

Response Body

On success, the server does not provide any body in the responses.

Type: identifier

Generic numeric identifier

JSON

integer

integer

Property Name	Type	Description	Notes
identifier	<integer>	Generic numeric identifier	Read-only; Minimum 1;

Type: unrestricted_name

Case sensitive name. Only alphanumeric, '-' and '_' are permitted.

JSON

string

string

Property Name	Type	Description	Notes
unrestricted_name	<string>	Case sensitive name. Only alphanumeric, '-' and '_' are permitted.	Pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]*$\|^[a-zA-Z0-9_-][a-zA-Z0-9 _-]+[a-zA-Z0-9_-]$';

Type: ipv4address

IPv4 address (x.y.z.k)

JSON

string

string

Property Name	Type	Description	Notes
ipv4address	<string>	IPv4 address (x.y.z.k)	Pattern: '^((?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?))?$';

Type: ipv4prefix

IPv4 prefix (x.y.z.k/mask)

JSON

string

string

Property Name	Type	Description	Notes
ipv4prefix	<string>	IPv4 prefix (x.y.z.k/mask)	Pattern: '^(?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)(/(3[012]\|[12]?[0-9]))$';

Type: hostname

Hostname

JSON

string

string

Property Name	Type	Description	Notes
hostname	<string>	Hostname	Pattern: '^((([a-zA-Z0-9]\|[a-zA-Z0-9][a-zA-Z0-9\-][a-zA-Z0-9])\.)([A-Za-z0-9]\|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9]))?$';

Type: interface

In-path interface

JSON

string

string

Property Name	Type	Description	Notes
interface	<string>	In-path interface	Pattern: '^inpath\d_\d\|primary';

Type: bandwidth_down

Download Bandwidth, in kbps

JSON

integer

integer

Property Name	Type	Description	Notes
bandwidth_down	<integer>	Download Bandwidth, in kbps	Range: 1 to 4294967295;

Type: bandwidth_up

Upload Bandwidth, in kbps

JSON

integer

integer

Property Name	Type	Description	Notes
bandwidth_up	<integer>	Upload Bandwidth, in kbps	Range: 1 to 4294967295;

Type: probe_dscp

DSCP Marking for path probe packets

JSON

integer

integer

Property Name	Type	Description	Notes
probe_dscp	<integer>	DSCP Marking for path probe packets	Range: 0 to 63;

Type: probe_timeout

Timeout in seconds, for path probe packets

JSON

integer

integer

Property Name	Type	Description	Notes
probe_timeout	<integer>	Timeout in seconds, for path probe packets	Range: 1 to 10;

Type: probe_threshold

Number of probes to detect a path as UP/DOWN

JSON

integer

integer

Property Name	Type	Description	Notes
probe_threshold	<integer>	Number of probes to detect a path as UP/DOWN	Range: 1 to 20;

Type: probing_bw

Probing bandwidth for this uplink in kbps

JSON

integer

integer

Property Name	Type	Description	Notes
probing_bw	<integer>	Probing bandwidth for this uplink in kbps	Range: 1 to 4294967295;

Type: positive_integer

JSON

integer

integer

Property Name	Type	Description	Notes
positive_integer	<integer>		Minimum 0;

Type: appliance

Appliance Object

JSON

{
  "id": identifier,
  "inventory_id": integer,
  "serial_number": string,
  "is_stc_member": boolean
}

{
  "id": identifier,
  "inventory_id": integer,
  "serial_number": string,
  "is_stc_member": boolean
}

Property Name	Type	Description	Notes
appliance	<object>	Appliance Object	Required properties: [inventory_id];
appliance.id	<identifier>	Generic numeric identifier	Read-only;
inventory_id	<integer>	unique id of appliance inventory service	Read-only; Minimum 1;
appliance.serial_number	<string>		Read-only; Optional;
appliance.is_stc_member	<boolean>	True if this appliance is part of a secure transport concentrator.	Read-only; Optional;

Type: site_uplink

Uplink object

JSON

{
  "id": identifier,
  "uplink_type_id": identifier,
  "uplink_type_name": string,
  "is_stc_uplink": boolean,
  "bandwidth_down": bandwidth_down,
  "bandwidth_up": bandwidth_up,
  "gateway_ip": ipv4address,
  "interface": interface,
  "nat": ipv4address,
  "probe_dscp": probe_dscp,
  "probe_timeout": probe_timeout,
  "probe_threshold": probe_threshold,
  "probing_bw": probing_bw,
  "is_firewalled": boolean,
  "is_default": boolean
}

{
  "id": identifier,
  "uplink_type_id": identifier,
  "uplink_type_name": string,
  "is_stc_uplink": boolean,
  "bandwidth_down": bandwidth_down,
  "bandwidth_up": bandwidth_up,
  "gateway_ip": ipv4address,
  "interface": interface,
  "nat": ipv4address,
  "probe_dscp": probe_dscp,
  "probe_timeout": probe_timeout,
  "probe_threshold": probe_threshold,
  "probing_bw": probing_bw,
  "is_firewalled": boolean,
  "is_default": boolean
}

Property Name	Type	Description	Notes
site_uplink	<object>	Uplink object	Required properties: [uplink_type_id, bandwidth_down, bandwidth_up, interface];
site_uplink.id	<identifier>	Generic numeric identifier	Read-only;
site_uplink.uplink_type_id	<identifier>	Generic numeric identifier	Read-only;
uplink_type_name	<string>	Case sensitive name. Only alphanumeric, '-' and '_' are permitted.	Read-only; Pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]*$\|^[a-zA-Z0-9_-][a-zA-Z0-9 _-]+[a-zA-Z0-9_-]$';
site_uplink.is_stc_uplink	<boolean>	Is this uplink used by the Secure transport concentrator?	Read-only; Optional;
site_uplink.bandwidth_down	<bandwidth_down>	Download Bandwidth, in kbps
site_uplink.bandwidth_up	<bandwidth_up>	Upload Bandwidth, in kbps
site_uplink.gateway_ip	<ipv4address>	IPv4 address (x.y.z.k)	Pattern: '^((?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?))?$';
site_uplink.interface	<interface>	In-path interface	Pattern: '^inpath\d_\d\|primary';
site_uplink.nat	<ipv4address>	IPv4 address (x.y.z.k)	Pattern: '^((?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?))?$';
site_uplink.probe_dscp	<probe_dscp>	DSCP Marking for path probe packets
site_uplink.probe_timeout	<probe_timeout>	Timeout in seconds, for path probe packets
site_uplink.probe_threshold	<probe_threshold>	Number of probes to detect a path as UP/DOWN
site_uplink.probing_bw	<probing_bw>	Probing bandwidth for this uplink in kbps
site_uplink.is_firewalled	<boolean>	Indicates whether the SteelHead accessing this Uplink is behind a firewall	Optional;
site_uplink.is_default	<boolean>	Indicates whether it is used as the interface default uplink	Optional;

Type: stc_uplink

Uplink which belongs to the Secure Transport Concentrator

JSON

{
  "uplink_type_id": identifier,
  "gateway_ip": ipv4address
}

{
  "uplink_type_id": identifier,
  "gateway_ip": ipv4address
}

Property Name	Type	Description	Notes
stc_uplink	<object>	Uplink which belongs to the Secure Transport Concentrator	Required properties: [uplink_type_id];
stc_uplink.uplink_type_id	<identifier>	Generic numeric identifier	Read-only;
stc_uplink.gateway_ip	<ipv4address>	IPv4 address (x.y.z.k)	Pattern: '^((?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?))?$';

Type: uplink

Uplink object

JSON

{
  "id": identifier,
  "uplink_type_id": identifier,
  "uplink_type_name": string,
  "bandwidth_down": bandwidth_down,
  "bandwidth_up": bandwidth_up,
  "gateway_ip": ipv4address,
  "interface": interface,
  "nat": ipv4address,
  "probe_dscp": probe_dscp,
  "probe_timeout": probe_timeout,
  "probe_threshold": probe_threshold,
  "probing_bw": probing_bw,
  "is_firewalled": boolean,
  "is_default": boolean
}

{
  "id": identifier,
  "uplink_type_id": identifier,
  "uplink_type_name": string,
  "bandwidth_down": bandwidth_down,
  "bandwidth_up": bandwidth_up,
  "gateway_ip": ipv4address,
  "interface": interface,
  "nat": ipv4address,
  "probe_dscp": probe_dscp,
  "probe_timeout": probe_timeout,
  "probe_threshold": probe_threshold,
  "probing_bw": probing_bw,
  "is_firewalled": boolean,
  "is_default": boolean
}

Property Name	Type	Description	Notes
uplink	<object>	Uplink object	Required properties: [uplink_type_id, bandwidth_down, bandwidth_up, interface];
uplink.id	<identifier>	Generic numeric identifier	Read-only;
uplink.uplink_type_id	<identifier>	Generic numeric identifier	Read-only;
uplink_type_name	<string>	Case sensitive name. Only alphanumeric, '-' and '_' are permitted.	Read-only; Pattern: '^[a-zA-Z0-9-][a-zA-Z0-9_-]*$\|^[a-zA-Z0-9_-][a-zA-Z0-9 _-]+[a-zA-Z0-9_-]$';
uplink.bandwidth_down	<bandwidth_down>	Download Bandwidth, in kbps
uplink.bandwidth_up	<bandwidth_up>	Upload Bandwidth, in kbps
uplink.gateway_ip	<ipv4address>	IPv4 address (x.y.z.k)	Pattern: '^((?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?))?$';
uplink.interface	<interface>	In-path interface	Pattern: '^inpath\d_\d\|primary';
uplink.nat	<ipv4address>	IPv4 address (x.y.z.k)	Pattern: '^((?:(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]\|2[0-4][0-9]\|[01]?[0-9][0-9]?))?$';
uplink.probe_dscp	<probe_dscp>	DSCP Marking for path probe packets
uplink.probe_timeout	<probe_timeout>	Timeout in seconds, for path probe packets
uplink.probe_threshold	<probe_threshold>	Number of probes to detect a path as UP/DOWN
uplink.probing_bw	<probing_bw>	Probing bandwidth for this uplink in kbps
uplink.is_firewalled	<boolean>	Indicates whether the SteelHead accessing this Uplink is behind a firewall	Optional;
uplink.is_default	<boolean>	Indicates whether it is used as the interface default uplink	Optional;

Type: secure_transport_concentrator

A secure concentrator consists of a dedicated appliance with secure uplinks ..

JSON

{
  "appliances": [ appliance ],
  "stc_uplinks": [ stc_uplink ],
  <prop>: any
}

{
  "appliances": [ appliance ],
  "stc_uplinks": [ stc_uplink ],
  <prop>: any
}

Property Name	Type	Description	Notes
secure_transport_concentrator	<object>	A secure concentrator consists of a dedicated appliance with secure uplinks ..	Required properties: [appliances, stc_uplinks];
secure_transport_concentrator.appliances	<array of <appliance>>
secure_transport_concentrator.appliances [items]	<appliance>	Appliance Object
secure_transport_concentrator. stc_uplinks	<array of <stc_uplink>>
secure_transport_concentrator. stc_uplinks[items]	<stc_uplink>	Uplink which belongs to the Secure Transport Concentrator
secure_transport_concentrator.<prop>	<any>		Optional;

Type: poller_response

JSON

{
  "poll_req_id": integer,
  "serial": string,
  "poll_time": integer,
  "resp_data": string,
  <prop>: any
}

{
  "poll_req_id": integer,
  "serial": string,
  "poll_time": integer,
  "resp_data": string,
  <prop>: any
}

Property Name	Type	Description	Notes
poller_response	<object>
poller_response.poll_req_id	<integer>	Request ID registered with poller	Optional;
poller_response.serial	<string>	Appliance from which response is received	Optional;
poller_response.poll_time	<integer>		Optional;
poller_response.resp_data	<string>	Response from the polled request	Optional;
poller_response.<prop>	<any>		Optional;