apis » cmc.sectransport » 2.0
REST API for secure transport managment v2.0
Created Nov 12, 2024 at 10:02 PM

Resource: peer_group_stats

Group-level stats for this peer relative to other peers in the group

http://{device}/api/cmc.sectransport/2.0/appliances/items/{serial}/group_stats{?start_time,group_id,end_time}
  • JSON
    • {
  "serial": string,
  "stats": [ datapoint ],
  "rekey_times": [
    integer
  ]
}
    Property Name Type Description Notes
    peer_group_stats <object> Group-level stats for this peer relative to other peers in the group Required properties: [serial];
    serial <string> Peer(appliance) for which this resource represents the stats
    peer_group_stats.stats <array of <datapoint>> Array of datapoints Optional;
    peer_group_stats.stats[items] <datapoint> Representation of a datapoints object
    peer_group_stats.rekey_times <array of <integer>> List of rekey timestamps Optional;
    peer_group_stats.rekey_times[items] <integer> Timestamp of rekey

    peer_group_stats: get

    GET http://{device}/api/cmc.sectransport/2.0/appliances/items/{serial}/group_stats{?start_time,group_id,end_time}
    Response Body

    Returns a peer_group_stats data object.

    Resource: all_peer_group_stats

    Peer group statistics for all peers belonging to a group

    http://{device}/api/cmc.sectransport/2.0/groups/items/{id}/all_peer_group_stats{?start_time,end_time}
  • JSON
    • {
  "id": integer,
  "peer_stats": [ peer_stats ]
}
    Property Name Type Description Notes
    all_peer_group_stats <object> Peer group statistics for all peers belonging to a group
    all_peer_group_stats.id <integer> Group Id for which this resource represents the stats Optional;
    all_peer_group_stats.peer_stats <array of <peer_stats>> Array of peer statistics Optional;
    all_peer_group_stats.peer_stats[items] <peer_stats> Representation of a peer statistics object

    all_peer_group_stats: get

    GET http://{device}/api/cmc.sectransport/2.0/groups/items/{id}/all_peer_group_stats{?start_time,end_time}
    Response Body

    Returns an all_peer_group_stats data object.

    Resource: group_stats

    Group-level stats

    http://{device}/api/cmc.sectransport/2.0/groups/items/{id}/group_stats{?start_time,end_time}
  • JSON
    • {
  "id": integer,
  "stats": [ datapoint ],
  "rekey_times": [
    integer
  ]
}
    Property Name Type Description Notes
    group_stats <object> Group-level stats
    group_stats.id <integer> Group Id for which this resource represents the stats Optional;
    group_stats.stats <array of <datapoint>> Array of datapoints Optional;
    group_stats.stats[items] <datapoint> Representation of a datapoints object
    group_stats.rekey_times <array of <integer>> List of rekey timestamps Optional;
    group_stats.rekey_times[items] <integer> Rekey timestamp

    group_stats: get

    GET http://{device}/api/cmc.sectransport/2.0/groups/items/{id}/group_stats{?start_time,end_time}
    Response Body

    Returns a group_stats data object.

    Resource: appliance

    Registered appliance

    http://{device}/api/cmc.sectransport/2.0/appliances/items/{serial}
  • JSON
    • {
  "id": integer,
  "serial": string,
  "name": string,
  "group_membership": [
    integer
  ]
}
    Property Name Type Description Notes
    appliance <object> Registered appliance
    appliance.id <integer> Appliance inventory id Optional;
    serial <string> Universally Unique Identifier
    appliance.name <string> The human readable name of the appliance Optional;
    appliance.group_membership <array of <integer>> What security groups this appliance belongs to Optional;
    appliance.group_membership[items] <integer> Group membership Id

    appliance: get

    GET http://{device}/api/cmc.sectransport/2.0/appliances/items/{serial}
    Response Body

    Returns an appliance data object.

    Relations

    appliance: instances

    Appliances resource

    Related resource

    appliances

    appliance: group_stats

    Peer group statistics resource

    Related resource

    peer_group_stats

    Variables
    Related var Data value for replacement
    serial 0/serial

    Resource: appliances

    ST information for all registered appliances on the system

    http://{device}/api/cmc.sectransport/2.0/appliances
  • JSON
    • {
  "items": [
    {
      "id": integer,
      "serial": string,
      "name": string,
      "group_membership": [
        integer
      ]
    }
  ]
}
    Property Name Type Description Notes
    appliances <object> ST information for all registered appliances on the system
    appliances.items <array of <items>> List of registered appliances Optional;
    items <object> Registered appliance
    items.id <integer> Appliance inventory id Optional;
    serial <string> Universally Unique Identifier
    items.name <string> The human readable name of the appliance Optional;
    items.group_membership <array of <integer>> What security groups this appliance belongs to Optional;
    items.group_membership[items] <integer> Group membership Id

    appliances: get

    GET http://{device}/api/cmc.sectransport/2.0/appliances
    Response Body

    Returns an appliances data object.

    Resource: group

    A secure transport group

    http://{device}/api/cmc.sectransport/2.0/groups/items/{id}
  • JSON
    • {
  "id": integer,
  "name": string,
  "key_auto_expiry": number,
  "data_rekey_volume": number,
  "rekey_pktprcnt": number,
  "rekey_pktcnt": integer,
  "headless_timeout": number,
  "keepalive_interval": integer,
  "members": [
    {
      "serial": serial,
      "name": string
    }
  ],
  <prop>: any
}
    Property Name Type Description Notes
    group <object> A secure transport group Required properties: [name];
    group.id <integer> Permanent ID of the group Read-only; Optional;
    group.name <string> Name of the group Read-only;
    group.key_auto_expiry <number> Max time in seconds that a key can be used Optional; Range: 31 to 31557600;
    group.data_rekey_volume <number> Max number of bytes that can be transfered in a security group before rekey Optional; Minimum 0;
    group.rekey_pktprcnt <number> Percentage of packets from max, when re-key must be performed Optional; Range: 0 to 100;
    group.rekey_pktcnt <integer> Cumulative packet counter for a SPI, after which re-key must be performed Optional; Minimum 0;
    group.headless_timeout <number> How long in seconds can an appliance run without controller link Optional; Range: 31 to 31557600;
    group.keepalive_interval <integer> How often should keep alive messages be sent between peers Optional; Range: 10 to 3600;
    group.members <array of <object>> The members of this security group Optional;
    group.members[items] <object> The member of this security group Read-only;
    group.members[items].serial <serial> Universally unique ID for an appliance
    group.members[items].name <string> The member name of this security group Read-only; Optional;
    group.<prop> <any> Optional;

    group: get

    GET http://{device}/api/cmc.sectransport/2.0/groups/items/{id}
    Response Body

    Returns a group data object.

    group: set

    PUT http://{device}/api/cmc.sectransport/2.0/groups/items/{id}
    Request Body

    Provide a group data object.

    Response Body

    Returns a group data object.

    Relations

    group: instances

    Groups resource

    Related resource

    groups

    group: group_stats

    Groups statistics resource

    Related resource

    group_stats

    Variables
    Related var Data value for replacement
    id 0/id

    Resource: groups

    All of the groups configured in the system

    http://{device}/api/cmc.sectransport/2.0/groups
  • JSON
    • {
  "items": [
    {
      "id": integer,
      "name": string,
      "key_auto_expiry": number,
      "data_rekey_volume": number,
      "rekey_pktprcnt": number,
      "rekey_pktcnt": integer,
      "headless_timeout": number,
      "keepalive_interval": integer,
      "members": [
        {
          "serial": serial,
          "name": string
        }
      ],
      <prop>: any
    }
  ]
}
    Property Name Type Description Notes
    groups <object> All of the groups configured in the system
    groups.items <array of <items>> List of groups configured Optional;
    items <object> A secure transport group Required properties: [name];
    items.id <integer> Permanent ID of the group Read-only; Optional;
    items.name <string> Name of the group Read-only;
    items.key_auto_expiry <number> Max time in seconds that a key can be used Optional; Range: 31 to 31557600;
    items.data_rekey_volume <number> Max number of bytes that can be transfered in a security group before rekey Optional; Minimum 0;
    items.rekey_pktprcnt <number> Percentage of packets from max, when re-key must be performed Optional; Range: 0 to 100;
    items.rekey_pktcnt <integer> Cumulative packet counter for a SPI, after which re-key must be performed Optional; Minimum 0;
    items.headless_timeout <number> How long in seconds can an appliance run without controller link Optional; Range: 31 to 31557600;
    items.keepalive_interval <integer> How often should keep alive messages be sent between peers Optional; Range: 10 to 3600;
    items.members <array of <object>> The members of this security group Optional;
    items.members[items] <object> The member of this security group Read-only;
    items.members[items].serial <serial> Universally unique ID for an appliance
    items.members[items].name <string> The member name of this security group Read-only; Optional;
    items.<prop> <any> Optional;

    groups: get

    GET http://{device}/api/cmc.sectransport/2.0/groups
    Response Body

    Returns a groups data object.

    Resource: configuration

    Secure Transport Configuration

    http://{device}/api/cmc.sectransport/2.0/configuration
  • JSON
    • {
  "groups": {
    "items": [
      {
        "id": integer,
        "name": string,
        "key_auto_expiry": number,
        "data_rekey_volume": number,
        "rekey_pktprcnt": number,
        "rekey_pktcnt": integer,
        "headless_timeout": number,
        "keepalive_interval": integer,
        "members": [
          {
            "serial": serial,
            "name": string
          }
        ],
        <prop>: any
      }
    ]
  },
  "revision": string
}
    Property Name Type Description Notes
    configuration <object> Secure Transport Configuration
    groups <object> All the groups configured in the system
    groups.items <array of <items>> List of groups configured Optional;
    items <object> A secure transport group Required properties: [name];
    items.id <integer> Permanent ID of the group Read-only; Optional;
    items.name <string> Name of the group Read-only;
    items.key_auto_expiry <number> Max time in seconds that a key can be used Optional; Range: 31 to 31557600;
    items.data_rekey_volume <number> Max number of bytes that can be transfered in a security group before rekey Optional; Minimum 0;
    items.rekey_pktprcnt <number> Percentage of packets from max, when re-key must be performed Optional; Range: 0 to 100;
    items.rekey_pktcnt <integer> Cumulative packet counter for a SPI, after which re-key must be performed Optional; Minimum 0;
    items.headless_timeout <number> How long in seconds can an appliance run without controller link Optional; Range: 31 to 31557600;
    items.keepalive_interval <integer> How often should keep alive messages be sent between peers Optional; Range: 10 to 3600;
    items.members <array of <object>> The members of this security group Optional;
    items.members[items] <object> The member of this security group Read-only;
    items.members[items].serial <serial> Universally unique ID for an appliance
    items.members[items].name <string> The member name of this security group Read-only; Optional;
    items.<prop> <any> Optional;
    configuration.revision <string> Revision of this configuration Optional;

    configuration: get

    GET http://{device}/api/cmc.sectransport/2.0/configuration
    Response Body

    Returns a configuration data object.

    Resource: poller

    Temporary callback for stats poll requests

    http://{device}/api/cmc.sectransport/2.0/poller_callback
  • JSON
    • {
  "poll_req_id": integer,
  "serial": string,
  "poll_time": integer,
  "resp_data": string
}
    Property Name Type Description Notes
    poller <object> Temporary callback for stats poll requests Required properties: [poll_req_id, serial, poll_time, resp_data];
    poller.poll_req_id <integer> Request id registered with poller
    poller.serial <string> Appliance from which response is received
    poller.poll_time <integer> Appliance poll time
    poller.resp_data <string> Response from the polled request

    poller: callback

    Callback to get polled response

    POST http://{device}/api/cmc.sectransport/2.0/poller_callback
    Request Body

    Provide a poller data object.

    Response Body

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

    Type: serial

    Universally unique ID for an appliance

  • JSON
    • string
    Property Name Type Description Notes
    serial <string> Universally unique ID for an appliance

    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: stat_block

    Representation of a statistics object

  • JSON
    • {
  "bytes_in": number,
  "bytes_out": number,
  "packets_in": number,
  "packets_out": number
}
    Property Name Type Description Notes
    stat_block <object> Representation of a statistics object
    stat_block.bytes_in <number> Bytes received Read-only; Optional;
    stat_block.bytes_out <number> Bytes sent Read-only; Optional;
    stat_block.packets_in <number> Packets received Read-only; Optional;
    stat_block.packets_out <number> Packets sent Read-only; Optional;

    Type: datapoint

    Representation of a datapoints object

  • JSON
    • {
  "timestamp": integer,
  "data": stat_block
}
    Property Name Type Description Notes
    datapoint <object> Representation of a datapoints object
    datapoint.timestamp <integer> Timestamp of datapoint Optional;
    datapoint.data <stat_block> Representation of a statistics object

    Type: peer_stats

    Representation of a peer statistics object

  • JSON
    • {
  "serial": string,
  "stats": [ datapoint ],
  "rekey_times": [
    integer
  ]
}
    Property Name Type Description Notes
    peer_stats <object> Representation of a peer statistics object
    serial <string> Peer(appliance) for which this resource represents the stats
    peer_stats.stats <array of <datapoint>> Array of datapoints Optional;
    peer_stats.stats[items] <datapoint> Representation of a datapoints object
    peer_stats.rekey_times <array of <integer>> List of rekey timestamps Optional;
    peer_stats.rekey_times[items] <integer> Timestamp of rekey