apis » cmc.applications » 2.0
SteelCentral Controller Applications Services v2.0
Created Nov 12, 2024 at 10:02 PM

Resource: business_criticalities

List of Business Criticalities. Business Criticality is one of the required properties of an Application and represents the business importance of an Application. This is a static list that cannot be modified.

http://{device}/api/cmc.applications/2.0/business_criticalities{?name}
  • JSON
    • [
  {
    "id": integer,
    "name": string,
    "dpi_version_min": number,
    "dpi_version_max": number
  }
]
    Property Name Type Description Notes
    business_criticalities <array of <object>> List of Business Criticalities. Business Criticality is one of the required properties of an Application and represents the business importance of an Application. This is a static list that cannot be modified.
    business_criticalities[items] <object> Read-only;
    id <integer> Business Criticality ID Read-only; Range: 1 to 18446744073709551615;
    name <string> Business Criticality Read-only; Pattern: '^(\S.*)?\S$';
    business_criticalities[items].
    dpi_version_min    		 <number> Read-only; Optional;
    business_criticalities[items].
    dpi_version_max    		 <number> Read-only; Optional;

    business_criticalities: get

    GET http://{device}/api/cmc.applications/2.0/business_criticalities{?name}
    Response Body

    Returns a business_criticalities data object.

    Resource: categories

    List of Categories. The Category is one of the required properties of an Application and represents the general function of an Application. This is a static list that cannot be modified.

    http://{device}/api/cmc.applications/2.0/categories{?name}
  • JSON
    • [
  {
    "id": integer,
    "name": string,
    "dpi_version_min": number,
    "dpi_version_max": number
  }
]
    Property Name Type Description Notes
    categories <array of <object>> List of Categories. The Category is one of the required properties of an Application and represents the general function of an Application. This is a static list that cannot be modified.
    categories[items] <object> Read-only;
    id <integer> Category ID Read-only; Range: 1 to 18446744073709551615;
    name <string> Category Read-only; Pattern: '^(\S.*)?\S$';
    categories[items].dpi_version_min <number> Read-only; Optional;
    categories[items].dpi_version_max <number> Read-only; Optional;

    categories: get

    GET http://{device}/api/cmc.applications/2.0/categories{?name}
    Response Body

    Returns a categories data object.

    Resource: traffic_types

    List of Traffic Types

    http://{device}/api/cmc.applications/2.0/traffic_types{?name}
  • JSON
    • [
  {
    "id": integer,
    "name": string
  }
]
    Property Name Type Description Notes
    traffic_types <array of <object>> List of Traffic Types
    traffic_types[items] <object>
    id <integer> Traffic Type ID Read-only; Range: 1 to 18446744073709551615;
    name <string> Traffic Type Pattern: '^[a-zA-Z0-9_-]+$';

    traffic_types: get

    Get the list of Traffic Types

    GET http://{device}/api/cmc.applications/2.0/traffic_types{?name}
    Response Body

    Returns a traffic_types data object.

    Resource: group

    http://{device}/api/cmc.applications/2.0/groups/items/{id}
  • JSON
    • {
  "id": identifier,
  "name": unrestricted_name,
  "brief_description": multiple,
  "long_description": multiple,
  "dpi_version_min": number,
  "dpi_version_max": number,
  "applications": [
    {
      "id": identifier,
      "name": unrestricted_name,
      "description": multiple,
      "tags": apptags,
      "is_built_in": boolean
    }
  ]
}
    Property Name Type Description Notes
    group <object> Required properties: [name];
    group.id <identifier> Generic numeric identifier Read-only;
    group.name <unrestricted_name> Application name field. Pattern: '^(\S.*)?\S$';
    group.brief_description <multiple> Brief description of the Application group Optional;
    group.brief_description.anyOf[0] <string>
    group.brief_description.anyOf[1] <null>
    group.long_description <multiple> Long description of the Application group Optional;
    group.long_description.anyOf[0] <string>
    group.long_description.anyOf[1] <null>
    group.dpi_version_min <number> Read-only; Optional;
    group.dpi_version_max <number> Read-only; Optional;
    group.applications <array of <object>> Array of applications that have this group associated with them. Array of tuples of (Application ID, Application Name) Optional;
    group.applications[items] <object>
    group.applications[items].id <identifier> Generic numeric identifier Read-only;
    group.applications[items].name <unrestricted_name> Application name field. Pattern: '^(\S.*)?\S$';
    group.applications[items].description <multiple> Optional;
    group.applications[items].description.
    anyOf[0]    		 <string>
    group.applications[items].description.
    anyOf[1]    		 <null>
    group.applications[items].tags <apptags> A snapshot of all the Application Tags in the system. To get the full details of a particular Application Tag use the 'apptag' resource. An Application Tag cannot be modified through this resource. To modify an Application Tag use the 'apptag' resource instead.
    group.applications[items].is_built_in <boolean> Read-only; Optional;

    group: get

    Retrieve details of an application group by ID

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

    Returns a group data object.

    Relations

    group: instances

    Related resource

    groups

    Resource: groups

    List of Application Groups. Group is one of the required properties of an Application. Each Group represents one of the most common Path Selection offload scenarios. This is a static list that cannot be modified.

    http://{device}/api/cmc.applications/2.0/groups{?name}
  • JSON
    • [
  {
    "id": integer,
    "name": string,
    "brief_description": multiple,
    "long_description": multiple,
    "dpi_version_min": number,
    "dpi_version_max": number
  }
]
    Property Name Type Description Notes
    groups <array of <object>> List of Application Groups. Group is one of the required properties of an Application. Each Group represents one of the most common Path Selection offload scenarios. This is a static list that cannot be modified.
    groups[items] <object> Read-only;
    id <integer> Generic numeric identifier Read-only; Range: 1 to 18446744073709551615;
    name <string> Application name field. Read-only; Pattern: '^(\S.*)?\S$';
    groups[items].brief_description <multiple> Brief description of the Application group Read-only; Optional;
    groups[items].brief_description.anyOf[0] <string> Read-only;
    groups[items].brief_description.anyOf[1] <null> Read-only;
    groups[items].long_description <multiple> Long description of the Application group Read-only; Optional;
    groups[items].long_description.anyOf[0] <string> Read-only;
    groups[items].long_description.anyOf[1] <null> Read-only;
    groups[items].dpi_version_min <number> Read-only; Optional;
    groups[items].dpi_version_max <number> Read-only; Optional;

    groups: get

    List all Application Groups

    GET http://{device}/api/cmc.applications/2.0/groups{?name}
    Response Body

    Returns a groups data object.

    Resource: l4protocols

    List of Layer 4 Protocols. This is a static list that cannot be modified.

    http://{device}/api/cmc.applications/2.0/l4protocols
  • JSON
    • [
  {
    "name": unrestricted_name,
    "number": number
  }
]
    Property Name Type Description Notes
    l4protocols <array of <object>> List of Layer 4 Protocols. This is a static list that cannot be modified.
    l4protocols[items] <object>
    l4protocols[items].name <unrestricted_name> Application name field. Pattern: '^(\S.*)?\S$';
    l4protocols[items].number <number> Layer 4 protocol Number Optional;

    l4protocols: get

    List all Layer 4 protocols

    GET http://{device}/api/cmc.applications/2.0/l4protocols
    Response Body

    Returns a l4protocols data object.

    Resource: l7protocol

    http://{device}/api/cmc.applications/2.0/l7protocols/items/{id}
  • JSON
    • {
  "id": integer,
  "name": string,
  "description": string,
  "dpi_version_min": number,
  "dpi_version_max": number,
  "metadata_keys": [
    string
  ],
  "priority_fields": [
    {
      "name": string,
      "priority": integer
    }
  ]
}
    Property Name Type Description Notes
    l7protocol <object>
    id <integer> Generic numeric identifier Read-only; Range: 1 to 18446744073709551615;
    name <string> Application name field. Read-only; Pattern: '^(\S.*)?\S$';
    l7protocol.description <string> Read-only; Optional;
    l7protocol.dpi_version_min <number> Read-only; Optional;
    l7protocol.dpi_version_max <number> Read-only; Optional;
    l7protocol.metadata_keys <array of <string>> List of keys associated with this L7 protocol Read-only; Optional;
    l7protocol.metadata_keys[items] <string> Name of a metadata key associated with this L7 protocol Read-only;
    l7protocol.priority_fields <array of <object>> List of priority fields associated with this L7 protocol. Tuples of (priority value, priority name). Optional;
    l7protocol.priority_fields[items] <object> Read-only;
    name <string> Application name field. Read-only; Pattern: '^(\S.*)?\S$';
    l7protocol.priority_fields[items].
    priority    		 <integer> Read-only; Optional;

    l7protocol: get

    Retrieve details of a Layer 7 Protocol by ID

    GET http://{device}/api/cmc.applications/2.0/l7protocols/items/{id}
    Response Body

    Returns a l7protocol data object.

    Relations

    l7protocol: instances

    Related resource

    l7protocols

    Resource: l7protocols

    A snapshot of all the Layer 7 Protocols in the system. This is a static list that cannot be modified. To get the full details of a particular Layer 7 Protocol use the 'l7protocol' resource.

    http://{device}/api/cmc.applications/2.0/l7protocols{?name}
  • JSON
    • [
  {
    "id": integer,
    "name": string,
    "description": string,
    "dpi_version_min": number,
    "dpi_version_max": number,
    "metadata_keys": [
      string
    ]
  }
]
    Property Name Type Description Notes
    l7protocols <array of <object>> A snapshot of all the Layer 7 Protocols in the system. This is a static list that cannot be modified. To get the full details of a particular Layer 7 Protocol use the 'l7protocol' resource.
    l7protocols[items] <object> Read-only;
    id <integer> Generic numeric identifier Read-only; Range: 1 to 18446744073709551615;
    name <string> Application name field. Read-only; Pattern: '^(\S.*)?\S$';
    l7protocols[items].description <string> L7Protocol Description Read-only; Optional;
    l7protocols[items].dpi_version_min <number> Read-only; Optional;
    l7protocols[items].dpi_version_max <number> Read-only; Optional;
    l7protocols[items].metadata_keys <array of <string>> List of keys associated with this L7 protocol Read-only; Optional;
    l7protocols[items].metadata_keys[items] <string> Name of a metadata key associated with this L7 protocol Read-only;

    l7protocols: get

    List all L7Protocols

    GET http://{device}/api/cmc.applications/2.0/l7protocols{?name}
    Response Body

    Returns a l7protocols data object.

    Resource: apptag

    http://{device}/api/cmc.applications/2.0/app_tags/items/{id}
  • JSON
    • {
  "id": identifier,
  "name": unrestricted_name,
  "is_built_in": boolean,
  "dpi_version_min": number,
  "dpi_version_max": number,
  "applications": [
    {
      "id": application_identifier,
      "name": string
    }
  ]
}
    Property Name Type Description Notes
    apptag <object> Required properties: [name];
    apptag.id <identifier> Generic numeric identifier Read-only;
    apptag.name <unrestricted_name> Application name field. Pattern: '^(\S.*)?\S$';
    apptag.is_built_in <boolean> This is a flag that specifies whether this tag is built_in and cannot be deleted. True indicates that it is built_in and cannot be deleted, False indicates that it is not built_in and can be deleted. Read-only; Optional;
    apptag.dpi_version_min <number> Read-only; Optional;
    apptag.dpi_version_max <number> Read-only; Optional;
    apptag.applications <array of <object>> Array of applications that have this tag associated with them. Array of tuples of (Application ID, Application Name) Optional;
    apptag.applications[items] <object>
    apptag.applications[items].id <application_identifier> Application numeric identifier
    name <string> Application name field. Read-only; Pattern: '^(\S.*)?\S$';

    apptag: get

    GET http://{device}/api/cmc.applications/2.0/app_tags/items/{id}
    Response Body

    Returns an apptag data object.

    Relations

    apptag: instances

    Related resource

    apptags

    Resource: apptags

    A snapshot of all the Application Tags in the system. To get the full details of a particular Application Tag use the 'apptag' resource. An Application Tag cannot be modified through this resource. To modify an Application Tag use the 'apptag' resource instead.

    http://{device}/api/cmc.applications/2.0/app_tags{?name}
  • JSON
    • [
  {
    "is_built_in": any,
    "id": integer,
    "name": string,
    "dpi_version_min": number,
    "dpi_version_max": number
  }
]
    Property Name Type Description Notes
    apptags <array of <object>> A snapshot of all the Application Tags in the system. To get the full details of a particular Application Tag use the 'apptag' resource. An Application Tag cannot be modified through this resource. To modify an Application Tag use the 'apptag' resource instead.
    apptags[items] <object> Read-only;
    apptags[items].is_built_in <any> This is a flag that specifies whether this tag is built_in and cannot be deleted. True indicates that it is built_in and cannot be deleted, False indicates that it is not built_in and can be deleted. Read-only; Optional;
    id <integer> Generic numeric identifier Read-only; Range: 1 to 18446744073709551615;
    name <string> Application name field. Read-only; Pattern: '^(\S.*)?\S$';
    apptags[items].dpi_version_min <number> Read-only; Optional;
    apptags[items].dpi_version_max <number> Read-only; Optional;

    apptags: get

    GET http://{device}/api/cmc.applications/2.0/app_tags{?name}
    Response Body

    Returns an apptags data object.

    Resource: application

    Definition of a QoS Application

    http://{device}/api/cmc.applications/2.0/applications/items/{id}
  • JSON
    • {
  "id": application_identifier,
  "name": unrestricted_name,
  "description": multiple,
  "traffic_type_id": multiple,
  "traffic_type_name": multiple,
  "l4_protocol_id": multiple,
  "l4_protocol_name": multiple,
  "dscp": multiple,
  "vlan": multiple,
  "local_port_portlabel": string,
  "remote_port_portlabel": string,
  "local_net_hostlabel": string,
  "remote_net_hostlabel": string,
  "l7_protocol_id": multiple,
  "l7_protocol_name": multiple,
  "l7_protocol_params": [
    {
      "name": string,
      "value": string
    }
  ],
  "tags": [
    {
      "is_built_in": any,
      "id": integer,
      "name": string,
      "dpi_version_min": number,
      "dpi_version_max": number
    }
  ],
  "group_id": integer,
  "group_name": string,
  "business_criticality_id": integer,
  "business_criticality_name": string,
  "category_id": integer,
  "category_name": string,
  "is_built_in": boolean,
  "dpi_version_min": number,
  "dpi_version_max": number
}
    Property Name Type Description Notes
    application <object> Definition of a QoS Application Required properties: [business_criticality_id, category_id, group_id, name];
    application.id <application_identifier> Application numeric identifier
    application.name <unrestricted_name> Application name field. Pattern: '^(\S.*)?\S$';
    application.description <multiple> Description of the Application Optional;
    application.description.anyOf[0] <string>
    application.description.anyOf[1] <null>
    application.traffic_type_id <multiple> ID of Traffic type that this application applies to. A value of 'null' here catches both optimized and pass-through traffic. Optional;
    application.traffic_type_id.anyOf[0] <integer>
    application.traffic_type_id.anyOf[1] <null>
    application.traffic_type_name <multiple> Traffic type (optimized, pass-through or both) that this application applies to. Read-only; Optional;
    application.traffic_type_name.anyOf[0] <name> Generic name field. Only alphanumeric '-' and '_' allowed Pattern: '^[a-zA-Z0-9_-]+$';
    application.traffic_type_name.anyOf[1] <null> Read-only;
    application.l4_protocol_id <multiple> ID of Layer 4 protocol of traffic that this application applies to. Foreign Key into the Layer 4 protocols table. Optional;
    application.l4_protocol_id.anyOf[0] <integer>
    application.l4_protocol_id.anyOf[1] <null>
    application.l4_protocol_name <multiple> Name of Layer 4 protocol of traffic that this application applies to. Read-only; Optional;
    application.l4_protocol_name.anyOf[0] <unrestricted_name> Application name field. Pattern: '^(\S.*)?\S$';
    application.l4_protocol_name.anyOf[1] <null> Read-only;
    application.dscp <multiple> Optional;
    application.dscp.anyOf[0] <dscp_match> DSCP number constrained type. Used for specifying match criteria.
    application.dscp.anyOf[1] <null>
    application.vlan <multiple> VLAN of traffic that this application applies to. A value of 'null' here catches all vlans. Optional;
    application.vlan.anyOf[0] <vlan>
    application.vlan.anyOf[1] <null>
    application.local_port_portlabel <string> Source port or name of Port Label specifying the traffic that this application applies to. Optional;
    application.remote_port_portlabel <string> Destination port or name of Port Label specifying the traffic that this application applies to. Optional;
    application.local_net_hostlabel <string> Source subnet or name of Host Label, specifying the traffic that this application applies to. Optional;
    application.remote_net_hostlabel <string> Destination subnet or name of Host Label, specifying the traffic that this application applies to. Optional;
    application.l7_protocol_id <multiple> ID of Layer 7 protocol of traffic that this application applies to. Foreign Key into the Layer 7 protocols table Optional;
    application.l7_protocol_id.anyOf[0] <integer>
    application.l7_protocol_id.anyOf[1] <null>
    application.l7_protocol_name <multiple> Name of Layer 7 protocol of traffic that this application applies to. Read-only; Optional;
    application.l7_protocol_name.anyOf[0] <unrestricted_name> Application name field. Pattern: '^(\S.*)?\S$';
    application.l7_protocol_name.anyOf[1] <null> Read-only;
    application.l7_protocol_params <array of <object>> List of parameters specific to the layer 7 protocol of this application Optional;
    application.l7_protocol_params[items] <object>
    application.l7_protocol_params[items].
    name    		 <string> Name of the L7protocol-metadata field Optional;
    application.l7_protocol_params[items].
    value    		 <string> Value of the L7protocol-metadata field Optional;
    tags <array of <object>> A snapshot of all the Application Tags in the system. To get the full details of a particular Application Tag use the 'apptag' resource. An Application Tag cannot be modified through this resource. To modify an Application Tag use the 'apptag' resource instead. Read-only;
    tags[items] <object> Read-only;
    tags[items].is_built_in <any> This is a flag that specifies whether this tag is built_in and cannot be deleted. True indicates that it is built_in and cannot be deleted, False indicates that it is not built_in and can be deleted. Read-only; Optional;
    id <integer> Generic numeric identifier Read-only; Range: 1 to 18446744073709551615;
    name <string> Application name field. Read-only; Pattern: '^(\S.*)?\S$';
    tags[items].dpi_version_min <number> Read-only; Optional;
    tags[items].dpi_version_max <number> Read-only; Optional;
    application.group_id <integer>
    group_name <string> Application name field. Read-only; Pattern: '^(\S.*)?\S$';
    business_criticality_id <integer> ID of the Business Criticality property of this application. Foreign Key into the Business_criticalities resource. Range: 1 to 18446744073709551615;
    business_criticality_name <string> Name of the Business Criticality property of this application. Represents the application's business importance. Read-only; Pattern: '^(\S.*)?\S$';
    category_id <integer> ID of the Category property of this application. Foreign Key into the Categories resource. Range: 1 to 18446744073709551615;
    category_name <string> Name of the Category property of this application. Represents the general function of this application. Read-only; Pattern: '^(\S.*)?\S$';
    application.is_built_in <boolean> Specifies whether the application is built_in Read-only; Optional;
    application.dpi_version_min <number> Read-only; Optional;
    application.dpi_version_max <number> Read-only; Optional;

    application: get

    Retrieve an application by ID

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

    Returns an application data object.

    application: set

    Replace the data representation for an application

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

    Provide an application data object.

    Response Body

    Returns an application data object.

    application: delete

    Delete an application by ID

    DELETE http://{device}/api/cmc.applications/2.0/applications/items/{id}
    Response Body

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

    Relations

    application: instances

    Related resource

    applications

    Resource: applications

    A snapshot of all the Applications in the system. To get the full details of a particular Application use the 'application' resource. An Application cannot be modified through this resource. To modify an Application use the 'application' resource.

    http://{device}/api/cmc.applications/2.0/applications{?is_built_in,group_id,business_criticality_id,category_id,name}
  • JSON
    • [
  {
    "business_criticality_name": string,
    "category_name": string,
    "id": integer,
    "name": string,
    "tags": [
      {
        "is_built_in": any,
        "id": integer,
        "name": string,
        "dpi_version_min": number,
        "dpi_version_max": number
      }
    ],
    "description": string,
    "group_name": string,
    "is_built_in": boolean
  }
]
    Property Name Type Description Notes
    applications <array of <object>> A snapshot of all the Applications in the system. To get the full details of a particular Application use the 'application' resource. An Application cannot be modified through this resource. To modify an Application use the 'application' resource.
    applications[items] <object> Read-only;
    business_criticality_name <string> Application name field. Read-only; Pattern: '^(\S.*)?\S$';
    category_name <string> Application name field. Read-only; Pattern: '^(\S.*)?\S$';
    id <integer> Application numeric identifier Read-only; Range: 1 to 65535;
    name <string> Application name field. Read-only; Pattern: '^(\S.*)?\S$';
    tags <array of <object>> A snapshot of all the Application Tags in the system. To get the full details of a particular Application Tag use the 'apptag' resource. An Application Tag cannot be modified through this resource. To modify an Application Tag use the 'apptag' resource instead. Read-only;
    tags[items] <object> Read-only;
    tags[items].is_built_in <any> This is a flag that specifies whether this tag is built_in and cannot be deleted. True indicates that it is built_in and cannot be deleted, False indicates that it is not built_in and can be deleted. Read-only; Optional;
    id <integer> Generic numeric identifier Read-only; Range: 1 to 18446744073709551615;
    name <string> Application name field. Read-only; Pattern: '^(\S.*)?\S$';
    tags[items].dpi_version_min <number> Read-only; Optional;
    tags[items].dpi_version_max <number> Read-only; Optional;
    applications[items].description <string> Description of the Application Read-only; Optional;
    group_name <string> Application name field. Read-only; Pattern: '^(\S.*)?\S$';
    applications[items].is_built_in <boolean> Specifies whether the application is built_in Read-only; Optional;

    applications: get

    List all Applications

    GET http://{device}/api/cmc.applications/2.0/applications{?is_built_in,group_id,business_criticality_id,category_id,name}
    Response Body

    Returns an applications data object.

    applications: set

    Delete all applications (not including built-in apps)

    PUT http://{device}/api/cmc.applications/2.0/applications{?is_built_in,group_id,business_criticality_id,category_id,name}
    Request Body

    Provide an empty_collection data object.

    Response Body

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

    applications: create

    Create a new Application

    POST http://{device}/api/cmc.applications/2.0/applications{?is_built_in,group_id,business_criticality_id,category_id,name}
    Request Body

    Provide an application data object.

    Response Body

    Returns an application data object.

    applications: find

    Find an Application with all the filters provided. This covers more filters than the one provided by params. Mainly used by qos migration to query for an application with all its properties. 

    POST http://{device}/api/cmc.applications/2.0/applications/find
    Request Body

    Provide a qos_application_type data object.

    Response Body

    Returns an application data object.

    Resource: brief_applications

    Get brief list of all Applications

    http://{device}/api/cmc.applications/2.0/brief_applications
  • JSON
    • [
  {
    "id": integer,
    "name": string,
    "description": string,
    "is_built_in": boolean
  }
]
    Property Name Type Description Notes
    brief_applications <array of <object>> Get brief list of all Applications
    brief_applications[items] <object>
    id <integer> Application numeric identifier Read-only; Range: 1 to 65535;
    name <string> Application name field. Read-only; Pattern: '^(\S.*)?\S$';
    brief_applications[items].description <string> Description of the Application Read-only; Optional;
    brief_applications[items].is_built_in <boolean> Specifies whether the application is built_in Read-only; Optional;

    brief_applications: get

    GET http://{device}/api/cmc.applications/2.0/brief_applications
    Response Body

    Returns a brief_applications data object.

    Resource: dpi_versions

    Returns DPI version in 'order' from low to high

    http://{device}/api/cmc.applications/2.0/dpi_versions
  • JSON
    • [
  {
    "type": dpi_info,
    <prop>: any
  }
]
    Property Name Type Description Notes
    dpi_versions <array of <object>> Returns DPI version in 'order' from low to high
    dpi_versions[items] <object>
    dpi_versions[items].type <dpi_info>
    dpi_versions[items].<prop> <any> Optional;

    dpi_versions: get

    GET http://{device}/api/cmc.applications/2.0/dpi_versions
    Response Body

    Returns a dpi_versions data object.

    Resource: dpi_applications

    Same as 'applications' get resource, but returns full application

    http://{device}/api/cmc.applications/2.0/dpi_applications
  • JSON
    • [
  {
    "id": application_identifier,
    "name": unrestricted_name,
    "description": multiple,
    "traffic_type_id": multiple,
    "traffic_type_name": multiple,
    "l4_protocol_id": multiple,
    "l4_protocol_name": multiple,
    "dscp": multiple,
    "vlan": multiple,
    "local_port_portlabel": string,
    "remote_port_portlabel": string,
    "local_net_hostlabel": string,
    "remote_net_hostlabel": string,
    "l7_protocol_id": multiple,
    "l7_protocol_name": multiple,
    "l7_protocol_params": [
      {
        "name": string,
        "value": string
      }
    ],
    "tags": [
      {
        "is_built_in": any,
        "id": integer,
        "name": string,
        "dpi_version_min": number,
        "dpi_version_max": number
      }
    ],
    "group_id": integer,
    "group_name": string,
    "business_criticality_id": integer,
    "business_criticality_name": string,
    "category_id": integer,
    "category_name": string,
    "is_built_in": boolean,
    "dpi_version_min": number,
    "dpi_version_max": number
  }
]
    Property Name Type Description Notes
    dpi_applications <array of <items>> Same as 'applications' get resource, but returns full application
    items <object> Definition of a QoS Application Required properties: [business_criticality_id, category_id, group_id, name];
    items.id <application_identifier> Application numeric identifier
    items.name <unrestricted_name> Application name field. Pattern: '^(\S.*)?\S$';
    items.description <multiple> Description of the Application Optional;
    items.description.anyOf[0] <string>
    items.description.anyOf[1] <null>
    items.traffic_type_id <multiple> ID of Traffic type that this application applies to. A value of 'null' here catches both optimized and pass-through traffic. Optional;
    items.traffic_type_id.anyOf[0] <integer>
    items.traffic_type_id.anyOf[1] <null>
    items.traffic_type_name <multiple> Traffic type (optimized, pass-through or both) that this application applies to. Read-only; Optional;
    items.traffic_type_name.anyOf[0] <name> Generic name field. Only alphanumeric '-' and '_' allowed Pattern: '^[a-zA-Z0-9_-]+$';
    items.traffic_type_name.anyOf[1] <null> Read-only;
    items.l4_protocol_id <multiple> ID of Layer 4 protocol of traffic that this application applies to. Foreign Key into the Layer 4 protocols table. Optional;
    items.l4_protocol_id.anyOf[0] <integer>
    items.l4_protocol_id.anyOf[1] <null>
    items.l4_protocol_name <multiple> Name of Layer 4 protocol of traffic that this application applies to. Read-only; Optional;
    items.l4_protocol_name.anyOf[0] <unrestricted_name> Application name field. Pattern: '^(\S.*)?\S$';
    items.l4_protocol_name.anyOf[1] <null> Read-only;
    items.dscp <multiple> Optional;
    items.dscp.anyOf[0] <dscp_match> DSCP number constrained type. Used for specifying match criteria.
    items.dscp.anyOf[1] <null>
    items.vlan <multiple> VLAN of traffic that this application applies to. A value of 'null' here catches all vlans. Optional;
    items.vlan.anyOf[0] <vlan>
    items.vlan.anyOf[1] <null>
    items.local_port_portlabel <string> Source port or name of Port Label specifying the traffic that this application applies to. Optional;
    items.remote_port_portlabel <string> Destination port or name of Port Label specifying the traffic that this application applies to. Optional;
    items.local_net_hostlabel <string> Source subnet or name of Host Label, specifying the traffic that this application applies to. Optional;
    items.remote_net_hostlabel <string> Destination subnet or name of Host Label, specifying the traffic that this application applies to. Optional;
    items.l7_protocol_id <multiple> ID of Layer 7 protocol of traffic that this application applies to. Foreign Key into the Layer 7 protocols table Optional;
    items.l7_protocol_id.anyOf[0] <integer>
    items.l7_protocol_id.anyOf[1] <null>
    items.l7_protocol_name <multiple> Name of Layer 7 protocol of traffic that this application applies to. Read-only; Optional;
    items.l7_protocol_name.anyOf[0] <unrestricted_name> Application name field. Pattern: '^(\S.*)?\S$';
    items.l7_protocol_name.anyOf[1] <null> Read-only;
    items.l7_protocol_params <array of <object>> List of parameters specific to the layer 7 protocol of this application Optional;
    items.l7_protocol_params[items] <object>
    items.l7_protocol_params[items].name <string> Name of the L7protocol-metadata field Optional;
    items.l7_protocol_params[items].value <string> Value of the L7protocol-metadata field Optional;
    tags <array of <object>> A snapshot of all the Application Tags in the system. To get the full details of a particular Application Tag use the 'apptag' resource. An Application Tag cannot be modified through this resource. To modify an Application Tag use the 'apptag' resource instead. Read-only;
    tags[items] <object> Read-only;
    tags[items].is_built_in <any> This is a flag that specifies whether this tag is built_in and cannot be deleted. True indicates that it is built_in and cannot be deleted, False indicates that it is not built_in and can be deleted. Read-only; Optional;
    id <integer> Generic numeric identifier Read-only; Range: 1 to 18446744073709551615;
    name <string> Application name field. Read-only; Pattern: '^(\S.*)?\S$';
    tags[items].dpi_version_min <number> Read-only; Optional;
    tags[items].dpi_version_max <number> Read-only; Optional;
    items.group_id <integer>
    group_name <string> Application name field. Read-only; Pattern: '^(\S.*)?\S$';
    business_criticality_id <integer> ID of the Business Criticality property of this application. Foreign Key into the Business_criticalities resource. Range: 1 to 18446744073709551615;
    business_criticality_name <string> Name of the Business Criticality property of this application. Represents the application's business importance. Read-only; Pattern: '^(\S.*)?\S$';
    category_id <integer> ID of the Category property of this application. Foreign Key into the Categories resource. Range: 1 to 18446744073709551615;
    category_name <string> Name of the Category property of this application. Represents the general function of this application. Read-only; Pattern: '^(\S.*)?\S$';
    items.is_built_in <boolean> Specifies whether the application is built_in Read-only; Optional;
    items.dpi_version_min <number> Read-only; Optional;
    items.dpi_version_max <number> Read-only; Optional;

    dpi_applications: get

    GET http://{device}/api/cmc.applications/2.0/dpi_applications
    Response Body

    Returns a dpi_applications data object.

    Type: identifier

    Generic numeric identifier

  • JSON
    • integer
    Property Name Type Description Notes
    identifier <integer> Generic numeric identifier Read-only; Range: 1 to 18446744073709551615;

    Type: non_read_only_identifier

    Generic numeric identifier

  • JSON
    • integer
    Property Name Type Description Notes
    non_read_only_identifier <integer> Generic numeric identifier Range: 1 to 18446744073709551615;

    Type: application_identifier

    Application numeric identifier

  • JSON
    • integer
    Property Name Type Description Notes
    application_identifier <integer> Application numeric identifier Range: 1 to 65535;

    Type: empty_collection

    Empty collection used to partially clear a collection

  • JSON
    • multiple
    Property Name Type Description Notes
    empty_collection <multiple> Empty collection used to partially clear a collection
    empty_collection.anyOf[0] <array of <null>> Maximum: 0 items;
    empty_collection.anyOf[0][items] <null>
    empty_collection.anyOf[1] <array of <string>> 1-1 items;
    empty_collection.anyOf[1][items] <string>

    Type: name

    Generic name field. Only alphanumeric '-' and '_' allowed

  • JSON
    • string
    Property Name Type Description Notes
    name <string> Generic name field. Only alphanumeric '-' and '_' allowed Pattern: '^[a-zA-Z0-9_-]+$';

    Type: dscp_match

    DSCP number constrained type. Used for specifying match criteria.

  • JSON
    • integer
    Property Name Type Description Notes
    dscp_match <integer> DSCP number constrained type. Used for specifying match criteria. Range: 0 to 63;

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

  • JSON
    • integer
    Property Name Type Description Notes
    vlan <integer> Range: 0 to 4094;

    Type: unrestricted_name

    Application name field.

  • JSON
    • string
    Property Name Type Description Notes
    unrestricted_name <string> Application name field. Pattern: '^(\S.*)?\S$';

    Type: qos_application_type

  • JSON
    • {
  "traffic_type_id": multiple,
  "l4_protocol_id": multiple,
  "dscp": multiple,
  "vlan": multiple,
  "local_port_portlabel": string,
  "remote_port_portlabel": string,
  "local_net_hostlabel": string,
  "remote_net_hostlabel": string,
  "l7_protocol_id": multiple,
  "l7_protocol_params": [
    {
      "name": string,
      "value": string
    }
  ]
}
    Property Name Type Description Notes
    qos_application_type <object>
    qos_application_type.traffic_type_id <multiple> Optional;
    qos_application_type.traffic_type_id.
    anyOf[0]    		 <integer>
    qos_application_type.traffic_type_id.
    anyOf[1]    		 <null>
    qos_application_type.l4_protocol_id <multiple> Optional;
    qos_application_type.l4_protocol_id.
    anyOf[0]    		 <integer>
    qos_application_type.l4_protocol_id.
    anyOf[1]    		 <null>
    qos_application_type.dscp <multiple> Optional;
    qos_application_type.dscp.anyOf[0] <dscp_match> DSCP number constrained type. Used for specifying match criteria.
    qos_application_type.dscp.anyOf[1] <null>
    qos_application_type.vlan <multiple> Optional;
    qos_application_type.vlan.anyOf[0] <vlan>
    qos_application_type.vlan.anyOf[1] <null>
    qos_application_type.
    local_port_portlabel    		 <string> Optional;
    qos_application_type.
    remote_port_portlabel    		 <string> Optional;
    qos_application_type.local_net_hostlabel <string> Optional;
    qos_application_type.
    remote_net_hostlabel    		 <string> Optional;
    qos_application_type.l7_protocol_id <multiple> Optional;
    qos_application_type.l7_protocol_id.
    anyOf[0]    		 <integer>
    qos_application_type.l7_protocol_id.
    anyOf[1]    		 <null>
    qos_application_type.l7_protocol_params <array of <object>> Optional;
    qos_application_type.l7_protocol_params
    [items]    		 <object>
    qos_application_type.l7_protocol_params
    [items].name    		 <string> Name of the L7protocol-metadata field Optional;
    qos_application_type.l7_protocol_params
    [items].value    		 <string> Value of the L7protocol-metadata field Optional;

    Type: dpi_info

  • JSON
    • {
  "id": number,
  "sh_dpi_version": string,
  "dpi_version": string
}
    Property Name Type Description Notes
    dpi_info <object>
    dpi_info.id <number> This is float value stored as primary key in SCC Read-only; Optional;
    dpi_info.sh_dpi_version <string> This is DPI version reported by SH Read-only; Optional;
    dpi_info.dpi_version <string> This is DPI version reported by vineyard Read-only; Optional;