Here is new documentation version.
You are reading outdated documentation, which will be shutdown soon!

REST API

REST API documentation API documentation version v1

Base URL: https://cloud.kaaiot.com/api/v1/al

Endpoint traffic

Operations on endpoint traffic.

/endpoint-traffic get

get /endpoint-traffic

Retrieves endpoint traffic.

Secured by oauth_2_0 with scopes:
  • endpoint:read

AL supports OAuth 2.0 for authenticating all API requests.

Query Parameters

  • sort: optional (createdAt - default: createdAt)

    Field to sort by.

    Example:

    createdAt
  • sortOrder: optional (one of asc, desc - default: desc)

    Sort direction.

    Example:

    asc
  • endpointIds: optional (string)

    Endpoint IDs.

    Example:

    feb060a4-66fb-4699-a591-4b3e49ae8821,7545fa87-c1e5-4dc7-ac51-987f22d30031
  • appVersionName: optional (string)

    Application version.

    Example:

    c8u2bklah5mkbalggie0-v1
  • extension: optional (one of dcx, cmx, cmx_ota, cex, epmx, rsx, bcx, adx)

    Extension.

    Example:

    dcx
  • payload: optional (string)

    Payload. Supports partial match.

    Example:

    temperature
  • resourcePath: optional (string)

    Resource path. Supports partial match.

    Example:

    command
  • requestId: optional (number)

    Request ID.

    Example:

    123
  • fromCreatedAt: optional (datetime)

    Timestamp in ISO 8601 format (UTC timezone) to filter traffic by creation time.

    Example:

    2023-06-30T12:30:54.540Z
  • toCreatedAt: optional (datetime)

    Timestamp in ISO 8601 format (UTC timezone) to filter traffic by creation time.

    Example:

    2023-06-30T12:35:54.540Z
  • page: optional (number - default: 0)

    Page number.

    Example:

    0
  • size: optional (number - default: 100)

    Page size.

    Example:

    10

HTTP status code 200

List is successfully retrieved.

Body

Media type: application/json

Type: object

Properties

  • totalElements: required(integer)

    Total number of elements available for retrieval.

  • content: required(array of ItemResponse)

    Items: ItemResponse

    • correlationId: required(string)

      Correlation ID.

    • direction: required(one of INBOUND, OUTBOUND)

      Traffic direction.

    • tenantId: optional (string)

      Tenant ID.

    • appVersionName: optional (string)

      Application version.

    • endpointId: optional (string)

      Endpoint ID that traffic belongs to.

    • resourcePath: optional (string)

      Resource path.

    • requestId: optional (number)

      Request ID.

    • payload: optional (string)

      Payload.

    • additionalMetadata: optional (object)

      Additional metadata related to traffic.

      • createdAt: required(datetime)

        Timestamp in ISO 8601 format (UTC timezone) showing when the traffic record was created.

        Example:

        2023-06-30T12:30:54.540Z

    Example:

    {
  "content": [
    {
      "correlationId": "I4QrB7",
      "direction": "OUTBOUND",
      "tenantId": "75b05695-27ca-46eb-9481-69c199088d99",
      "appVersionName": "c8u2bklah5mkbalggie0-v1",
      "endpointId": "f59a5f45-875d-4dcb-95eb-b017ef9a0638",
      "resourcePath": "/json",
      "requestId": 123,
      "payload": "{\"temperature\":23\"}",
      "createdAt": "2023-06-30T12:30:54.540Z",
      "additionalMetadata": {
        "statusCode": 200,
        "reasonPhrase": "OK",
        "extensionInstanceName": "cex"
      }
    }
  ],
  "totalElements": 1
}

    HTTP status code 401

    Request is not authenticated.

    Secured by oauth_2_0

    Headers

    • Authorization: optional (string)

      Used to send a valid OAuth 2 access token. Example: "Authorization: Bearer 'access_token'" where 'access_token' must be replaced by a valid OAuth access token. This header is needed only if API authentication is enabled for the service.