HTTP status code 201

Endpoint successfully registered within the application version.

Headers

• Location: required(string)

  URI in format {schema}://{host}:{port}/api/v1/endpoints/{endpointId}

  Example:

  http://example.com/api/v1/endpoints/79c717d9-eedd-4f71-b9f8-86caf7e309e4

Body

Media type: application/json

Type: object

Properties

• token: required(string)

  Endpoint token.

• status: required(Inactive)

  Status of newly provisioned token is always Inactive.
  Token status will be automatically changed to Active after first successful token validation request.

Example:

{
  "token": "02226466-e744-48ac-8f0c-a57fe4e77de4",
  "status": "Inactive"
}

HTTP status code 400

Invalid application version name.

HTTP status code 403

User does not have permissions to perform this operation.

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.

HTTP status code 200

Array of endpoint system attributes successfully retrieved.

Headers

• ETag: required(string)

  Represents the current endpoint list state.
  The value can be used in If-Match and If-None-Match headers.

  Example:

  "33a64df551425fcc55e4d42a148795d9f25f89d4"
  

Body

Media type: application/json

Type: object

Properties

• totalElements: required(integer)

  Total number of elements available for retrieval. Current response may return only a part of all available elements.

• content: required(array of Endpoint)

  Items: Endpoint

  • endpointId: required(string)

    Unique identifier of endpoint.

  • createdDate: required(datetime)

    Endpoint registration data in ISO 8601 format (UTC timezone).

  • appVersion: required(object)

    Information about endpoint registration wthin specific application version.

    • name: required(string)

      Name of the application version.

    • registeredDate: required(datetime)

      Date when endpoint registration data was created within specific application version.

  • metadata: optional (object)

    Endpoint metadata consists of multiple key-value pairs (called fields) where keys are strings, and the values are of any JSON type.
  • metadataUpdatedDate: optional (datetime)

    Timestamp in ISO 8601 format (UTC timezone) showing when the endpoint metadata was last updated.

  • filters: required(array of )

    List of filters that matches to the endpoint.

Example:

{
  "totalElements": 1,
  "content": [
    {
      "endpointId": "5a67aa97-1f5c-41eb-a066-8e004157062b",
      "createdDate": "2017-04-20T11:19:57.848Z",
      "appVersion": {
        "name": "example_app_v1",
        "registeredDate": "2017-04-20T11:19:57.848Z"
      },
      "metadata": {
        "OS": {
          "type": "Linux",
          "version": "4.10.6"
        },
        "tag": {
          "id": "1"
        },
        "anyJsonType": [
          11
        ]
      },
      "metadataUpdatedDate" : "2017-04-20T12:07:19.112Z",
      "filters": [
        "9e569809-e316-422f-851e-8d916ea0e89a"
      ]
    }
  ]
}

HTTP status code 304

Resource(s) not modified.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

• message: required(string)

  Detailed error description.

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.

HTTP status code 202

Batch endpoint registration task is accepted.

Body

Media type: application/json

Type: object

Properties

• taskId: required(string)

  Batch endpoints registration task ID.

Example:

{
  "taskId":"79c717d9-eedd-4f71-b9f8-86caf69809e4"
}

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

• message: required(string)

  Detailed error description.

HTTP status code 403

User does not have permissions to perform this operation.

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.

HTTP status code 200

Batch endpoint registration task's status is successfully retrieved.

Body

Media type: application/json

Type: object

Properties

• createdCount: required(integer)

  Count of endpoints with successful registration.

• failedCount: required(integer)

  Count of endpoints with failed registration.

• created: required(array of CreatedBatchEndpointRegistrationItem)

  Array of endpoints with successful registration.

  Items: CreatedBatchEndpointRegistrationItem

  • endpointId: optional (string)

    Endpoint ID.

  • endpointToken: required(string)

    Endpoint token.

• failed: required(array of FailedBatchEndpointRegistrationItem)

  Array of endpoints with failed registration.

  Items: FailedBatchEndpointRegistrationItem

  • endpointToken: required(string)

    Endpoint token.

  • statusReason: optional (string)

    Cause of failing endpoint registration.

Example:

{
  "createdCount": 2,
  "failedCount": 1,
  "created": [
    {
      "endpointId": "56726466-e454-23ac-340c-f34fefda7de4",
      "endpointToken": "02226466-e744-48ac-8f0c-a57fe4e77de4"
    },
    {
      "endpointId": "56726466-e454-23ac-340c-f34fefda7df2",
      "endpointToken": "02226466-e744-48ac-8f0c-a57fe4e35db2"
    }
  ],
  "failed": [
    {
      "endpointToken": "02226466-e744-48ac-8f0c-a57fe4f48d5f",
      "statusReason": "Endpoint token already exists."
    }
  ]
}

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

• message: required(string)

  Detailed error description.

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.

HTTP status code 200

Object successfully retrieved.

Headers

• ETag: required(string)

  Represents the current endpoint state.
  The value can be used in If-Match and If-None-Match headers.

  Example:

  "33a64df551425fcc55e4d42a148795d9f25f89d4"
  

• Last-Modified: required(datetime)

  The last modifcation date of endpoint.

  Example:

  Tue, 05 Sep 2017 08:21:44 GMT

Body

Media type: application/json

Type: object

Properties

• endpointId: required(string)

  Unique identifier of endpoint.

• createdDate: required(datetime)

  Endpoint registration data in ISO 8601 format (UTC timezone).

• appVersion: required(object)

  Information about endpoint registration wthin specific application version.

  • name: required(string)

    Name of the application version.

  • registeredDate: required(datetime)

    Date when endpoint registration data was created within specific application version.

• metadata: optional (object)

  Endpoint metadata consists of multiple key-value pairs (called fields) where keys are strings, and the values are of any JSON type.
• metadataUpdatedDate: optional (datetime)

  Timestamp in ISO 8601 format (UTC timezone) showing when the endpoint metadata was last updated.

• filters: required(array of )

  List of filters that matches to the endpoint.

Example:

{
  "endpointId": "69c4c970-94ce-4608-bf36-736d16fdab82",
  "createdDate": "2017-04-20T11:19:57.848Z",
  "appVersion": {
    "name": "example_app_v1",
    "registeredDate": "2017-04-20T11:19:57.848Z"
  },
  "metadata": {
    "OS": {
      "type": "Linux",
      "version": "4.10.6"
    },
    "tag": {
      "id": "1"
    },
    "anyJsonType": [
      11
    ]
  },
  "metadataUpdatedDate": "2017-04-20T15:01:12.144Z",
  "filters": [
    "58229325-8444-4394-a4c2-1ef2b44160f5"
  ]
}

HTTP status code 304

Resource(s) not modified.

HTTP status code 400

Invalid include query parameter.

Body

Media type: application/json

Type: object

Properties

• message: required(string)

  Detailed error description.

HTTP status code 404

Endpoint not found or querying user is not authorized for it.

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.

HTTP status code 200

Endpoint registration data retrieved successfully.

Body

Media type: application/json

Type: object

Properties

• name: required(string)

  Name of the application version.

• registeredDate: required(datetime)

  Date when endpoint registration data was created within specific application version.

Example:

{
  "name": "example_app_v1",
  "registeredDate": "2017-04-20T11:19:57.848Z"
}

HTTP status code 404

Endpoint not found or querying user is not authorized for it.

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.

HTTP status code 204

Endpoint registration data updated successfully.

HTTP status code 400

Invalid application version name.

Body

Media type: application/json

Type: object

Properties

• message: required(string)

  Detailed error description.

HTTP status code 404

Endpoint not found or querying user is not authorized for it.

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.

HTTP status code 200

Endpoint metadata of the specified endpoint.

Headers

• ETag: required(string)

  Represents the current endpoint's metadata state.
  The value can be used in If-Match and If-None-Match headers.

  Example:

  "33a64df551425fcc55e4d42a148795d9f25f89d4"
  

• Last-Modified: required(datetime)

  The last modifcation date of endpoint's metadata.

  Example:

  Tue, 05 Sep 2017 08:21:44 GMT

Body

Media type: application/json

Type: object

Example:

{
  "OS":{
    "type":"Linux",
    "version":"4.10.6"
  },
  "tag":{
    "id":"1"
  },
  "anyJsonType":[
    11
  ]
}

HTTP status code 304

Resource(s) not modified.

HTTP status code 400

Metadata keys are not valid.

HTTP status code 404

Endpoint not found or querying user is not authorized for it.

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.

HTTP status code 204

Endpoint metadata successfully updated.

HTTP status code 400

Payload is not a JSON object or metadata keys are not valid.

HTTP status code 404

Endpoint not found or querying user is not authorized for it.

HTTP status code 412

At least one of the preconditions specified in If-Match or If-Unmodified-Since headers failed.

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.

HTTP status code 200

Endpoint metadata successfully patched.

Body

Media type: application/json

Type: object

Example:

{
  "OS":{
    "type":"Linux",
    "version":"4.10.6"
  },
  "tag":{
    "id":"1"
  },
  "anyJsonType":[
    11
  ]
}

HTTP status code 400

Invalid JSON Patch format or metadata keys are not valid.

HTTP status code 404

Endpoint not found or querying user is not authorized for it.

HTTP status code 412

At least one of the preconditions specified in If-Match or If-Unmodified-Since headers failed.

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.

HTTP status code 200

Metadata value for the specified key.

Body

Media type: application/json

Type: any

Examples:

{
  "kernel": "Linux",
  "version": 5
}

"value1"

false

[
  1,
  2.3,
  4
]

2

HTTP status code 400

Bad request.

HTTP status code 404

Endpoint or metadata key not found or user is not authorized for the endpoint.

Body

Media type: application/json

Type: object

Properties

• message: required(string)

  Detailed error description.

Examples:

{
  "message": "No endpoint found."
}

{
  "message": "No metadata key found."
}

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.

HTTP status code 200

Single endpoint metadata key-value pair successfully updated.

Body

Media type: application/json

Type: any

Examples:

{
  "kernel": "Linux",
  "version": 5
}

"value1"

false

[
  1,
  2.3,
  4
]

2

HTTP status code 201

Single endpoint metadata key-value pair successfully created.

Headers

• Location: required(string)

  Location of the newly created endpoint metadata key-value pair. The format is as follows: {schema}://{host}:{port}/api/{version}/endpoints/{endpointId}/metadata/{metadataKey}

  Example:

  http://example.com/api/v1/endpoints/79c717d9-eedd-4f71-b9f8-86caf7e309e4/metadata/OS

Body

Media type: application/json

Type: any

Examples:

{
  "kernel": "Linux",
  "version": 5
}

"value1"

false

[
  1,
  2.3,
  4
]

2

HTTP status code 400

Invalid JSON value or metadata key is not valid.

HTTP status code 404

Endpoint not found or querying user is not authorized for it.

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.

HTTP status code 204

Endpoint metadata key successfully deleted.

HTTP status code 400

Invalid metadata key.

HTTP status code 404

Endpoint or metadata key not found or user is not authorized for the endpoint.

Body

Media type: application/json

Type: object

Properties

• message: required(string)

  Detailed error description.

Examples:

{
  "message": "No endpoint found."
}

{
  "message": "No metadata key found."
}

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.

HTTP status code 200

Array that contains all metadata fields.

Headers

• ETag: required(string)

  Represents the current metadata keys state.
  The value can be used in If-Match and If-None-Match headers.

  Example:

  "33a64df551425fcc55e4d42a148795d9f25f89d4"
  

Body

Media type: application/json

Type: array of string

Example:

[
  "OS",
  "country",
  "level"
]

HTTP status code 304

Resource(s) not modified.

HTTP status code 404

Endpoint not found or querying user is not authorized for it.

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.