REST API for SCC Sites and Uplinks v1.0
Created Dec 18, 2020 at 07:15 PM

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.0/bandwidth_usage{?start_time,site_id,end_time}
  • JSON
  • {
      "start_time": timestamp,
      "end_time": timestamp,
      "total_lan": number,
      "total_wan": number,
      "data": [
        {
          "lan": number,
          "wan": number,
          "timestamp": timestamp
        }
      ]
    }
    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 <timestamp> Optional; Seconds since January 1, 1970;
    bandwidth_usage.end_time <timestamp> Optional; Seconds since January 1, 1970;
    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 <timestamp> Read-only; Optional; Seconds since January 1, 1970;

    Resource: site

    Site object

    http://{device}/api/cmc.topology/1.0/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 ]
    }
    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;

    Relations

    site: instances

    Related resource

    sites

    Resource: brief_sites

    List of Sites without the subnets

    http://{device}/api/cmc.topology/1.0/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 ],
        <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].<prop> <any> Optional;

    Resource: sites

    List of Sites

    http://{device}/api/cmc.topology/1.0/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 ]
      }
    ]
    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;

    Resource: appliances

    All appliances in sites

    http://{device}/api/cmc.topology/1.0/sites/appliances{?secure_capable}
  • JSON
  • [ appliance ]
    Property Name Type Description Notes
    appliances <array of <appliance>> All appliances in sites
    appliances[items] <appliance> Appliance Object

    Resource: site_connectivity_template

    Template of site connectivity parameters

    http://{device}/api/cmc.topology/1.0/site_connectivity_templates/items/{id}
  • JSON
  • {
      "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

    Relations

    site_connectivity_template: instances

    Related resource

    site_connectivity_templates

    Resource: site_connectivity_templates

    http://{device}/api/cmc.topology/1.0/site_connectivity_templates
    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

    Resource: network

    Network object

    http://{device}/api/cmc.topology/1.0/networks/items/{id}
  • JSON
  • {
      "id": integer,
      "name": string,
      "security_level": integer,
      "is_public": boolean,
      "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.is_built_in <boolean> Read-only; Optional;

    Relations

    network: instances

    Related resource

    networks

    Resource: networks

    List of Networks

    http://{device}/api/cmc.topology/1.0/networks{?name}
  • JSON
  • [ network ]
    Property Name Type Description Notes
    networks <array of <network>> List of Networks
    networks[items] <network> Network object

    Resource: site_type

    Type of category and function of the site

    http://{device}/api/cmc.topology/1.0/site_types/items/{id}
  • JSON
  • {
      "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;

    Relations

    site_type: instances

    Related resource

    site_types

    Resource: site_types

    List of site types

    http://{device}/api/cmc.topology/1.0/site_types{?name}
  • JSON
  • [
      {
        "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;

    Resource: site_type_stats

    Get the status for a site.

    http://{device}/api/cmc.topology/1.0/site_types/items/{site_type_id}/stats{?start_time,end_time}
  • JSON
  • {
      "site_type_id": integer,
      "start_time": timestamp,
      "end_time": timestamp,
      "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 <timestamp> Optional; Seconds since January 1, 1970;
    site_type_stats.end_time <timestamp> Optional; Seconds since January 1, 1970;
    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;

    Resource: region

    Physical region of the property

    http://{device}/api/cmc.topology/1.0/regions/items/{id}
  • JSON
  • {
      "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_-]$';

    Relations

    region: instances

    Related resource

    regions

    Resource: regions

    List of regions

    http://{device}/api/cmc.topology/1.0/regions{?name}
  • JSON
  • [ region ]
    Property Name Type Description Notes
    regions <array of <region>> List of regions
    regions[items] <region> Physical region of the property

    Resource: poller

    Callback for polled requests to the appliance

    http://{device}/api/cmc.topology/1.0/poller_callback
  • JSON
  • {
      <prop>: any
    }
    Property Name Type Description Notes
    poller <object> Callback for polled requests to the appliance
    poller.<prop> <any> Optional;

    Type: identifier

    Generic numeric identifier

  • JSON
  • 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
    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
    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
    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
    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
    Property Name Type Description Notes
    interface <string> In-path interface Pattern: '^inpath\d_\d|primary';

    Type: bandwidth_down

    Download Bandwidth, in kbps

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

    Type: bandwidth_up

    Upload Bandwidth, in kbps

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

    Type: probe_dscp

    DSCP Marking for path probe packets

  • JSON
  • 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
    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
    Property Name Type Description Notes
    probe_threshold <integer> Number of probes to detect a path as UP/DOWN Range: 1 to 20;

    Type: positive_integer

  • JSON
  • 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
    }
    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: secure_transport_concentrator

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

  • JSON
  • {
      "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": timestamp,
      "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 <timestamp> Optional; Seconds since January 1, 1970;
    poller_response.resp_data <string> Response from the polled request Optional;
    poller_response.<prop> <any> Optional;