HTTP status code 201

Application integration was successfully created.

Headers

• Location: required(string)

  URI in format {schema}://{host}:{port}/api/v1/integrations/{id}

  Example:

  http://example.com/api/v1/integrations/267

Body

Media type: application/json

Type: object

• id: required(integer)

  Application integration unique identifier.

• appName: required(string)

  The KaaIoT platform application name.

• ttnUsername: required(string)

  The Things Network username.

• ttnIdentityServerHost: required(string)

  The Things Network Identity Server host address.

• ttnNetworkServerHost: (string)

  The Things Network (TTN) Network Server host address.

• ttnJoinServerHost: (string)

  The Things Network Join Server host address.

• ttnApplicationServerHost: (string)

  The Things Network Application Server host address.

• ttnPlainMqttServerUrl: (string)

  The Things Network MQTT Server URL address.

• ttnMqttIntegrationEnabled: required(boolean)

  Enable TTN MQTT integration MQTT. false when, for example, used Node-red for message parsing. In such a case ttnPlainMqttServerUrl not used.

• name: required(string)

  Application integration name.

• description: (string)

  Application integration description.

• status: required(one of ACTIVE, SUSPENDED)

  Application integration status.

• poolIds: (array of string)

  An array of the unique identifiers of the pools to which the application integration will be attached.

Example:

{
  "id": 267,
  "appName": "q4hhh0cckgmc6ivflvag",
  "ttnUsername": "lorawan-farm-app@ttn",
  "ttnIdentityServerHost":"eu1.cloud.thethings.network",
  "ttnJoinServerHost":"eu1.cloud.thethings.network",
  "ttnNetworkServerHost":"eu1.cloud.thethings.network",
  "ttnApplicationServerHost":"eu1.cloud.thethings.network",
  "ttnPlainMqttServerUrl": "eu1.cloud.thethings.network:1883",
  "ttnMqttIntegrationEnabled": true,
  "name": "Smart Farm",
  "description": "Smart farm LoRaWAN devices integration",
  "status": "ACTIVE"
}

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

HTTP status code 403

User does not have permissions to perform this operation.

HTTP status code 409

TtnUsername or appName already used by some application integration.

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

Example:

{
  "message": "Application name [c7r38d3a8vkfafj9jipg] already used in other application integration."
}

Secured by oauth_2_0

Headers

• Authorization: (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

Application integrations are successfully retrieved.

Body

Media type: application/json

Type: object

• 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 app-dev-integration-types.AppIntegrationDetailedResponse)

  Items: AppIntegrationDetailedResponse

  • id: required(integer)

    Application integration unique identifier.

  • appName: required(string)

    The KaaIoT platform application name.

  • ttnUsername: required(string)

    The Things Network username.

  • ttnIdentityServerHost: required(string)

    The Things Network Identity Server host address.

  • ttnNetworkServerHost: (string)

    The Things Network (TTN) Network Server host address.

  • ttnJoinServerHost: (string)

    The Things Network Join Server host address.

  • ttnApplicationServerHost: (string)

    The Things Network Application Server host address.

  • ttnPlainMqttServerUrl: (string)

    The Things Network MQTT Server URL address.

  • ttnMqttIntegrationEnabled: required(boolean)

    Enable TTN MQTT integration MQTT. false when, for example, used Node-red for message parsing. In such a case ttnPlainMqttServerUrl not used.

  • name: required(string)

    Application integration name.

  • description: (string)

    Application integration description.

  • status: required(one of ACTIVE, SUSPENDED)

    Application integration status.

  • ttnConnectionState: required(one of CONNECTED, DISCONNECTED)

    Application integration TTN MQTT connection state.

    • `CONNECTED` - connection successful
    • `DISCONNECTED` - There is some problem with the connection
    
    
  • ttnConnectionError: (string)

    Error description (if there is any problem with the TTN MQTT connection).

  • kpcConnectionState: required(one of CONNECTED, DISCONNECTED)

    Tenant application integrations KPC MQTT connection state.

    • `CONNECTED` - connection successful
    • `DISCONNECTED` - There is some problem with the connection
    
    
  • kpcConnectionError: (string)

    Error description (if there is any problem with the KPC MQTT connection for the tenant).

Example:

{
  "totalElements": 2,
  "content": [
    {
      "id": 267,
      "appName": "q4hhh0cckgmc6ivflvag",
      "ttnUsername": "lorawan-smart-farm@ttn",
      "ttnIdentityServerHost":"eu1.cloud.thethings.network",
      "ttnJoinServerHost":"eu1.cloud.thethings.network",
      "ttnNetworkServerHost":"eu1.cloud.thethings.network",
      "ttnApplicationServerHost":"eu1.cloud.thethings.network",
      "ttnPlainMqttServerUrl": "eu1.cloud.thethings.network:1883",
      "ttnMqttIntegrationEnabled": true,
      "name": "Smart Farm",
      "description": "Smart farm LoRaWAN devices integration",
      "status": "ACTIVE",
      "ttnConnectionState": "CONNECTED",
      "kpcConnectionState": "CONNECTED"
    },
    {
      "id": 351,
      "appName": "0cckq4hhhgmc6ivflasd",
      "ttnUsername": "lorawan-smart-farm2@ttn",
      "ttnIdentityServerHost":"eu1.cloud.thethings.network",
      "ttnJoinServerHost":"eu1.cloud.thethings.network",
      "ttnNetworkServerHost":"eu1.cloud.thethings.network",
      "ttnApplicationServerHost":"eu1.cloud.thethings.network",
      "ttnMqttIntegrationEnabled": false,
      "name": "Smart Farm",
      "description": "Smart farm LoRaWAN devices integration",
      "status": "SUSPENDED",
      "ttnConnectionState": "DISCONNECTED",
      "ttnConnectionError": "Not authorized to connect",
      "kpcConnectionState": "CONNECTED"
    }
  ]
}

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

Secured by oauth_2_0

Headers

• Authorization: (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

Application integration is successfully retrieved.

Body

Media type: application/json

Type: object

• id: required(integer)

  Application integration unique identifier.

• appName: required(string)

  The KaaIoT platform application name.

• ttnUsername: required(string)

  The Things Network username.

• ttnIdentityServerHost: required(string)

  The Things Network Identity Server host address.

• ttnNetworkServerHost: (string)

  The Things Network (TTN) Network Server host address.

• ttnJoinServerHost: (string)

  The Things Network Join Server host address.

• ttnApplicationServerHost: (string)

  The Things Network Application Server host address.

• ttnPlainMqttServerUrl: (string)

  The Things Network MQTT Server URL address.

• ttnMqttIntegrationEnabled: required(boolean)

  Enable TTN MQTT integration MQTT. false when, for example, used Node-red for message parsing. In such a case ttnPlainMqttServerUrl not used.

• name: required(string)

  Application integration name.

• description: (string)

  Application integration description.

• status: required(one of ACTIVE, SUSPENDED)

  Application integration status.

• ttnConnectionState: required(one of CONNECTED, DISCONNECTED)

  Application integration TTN MQTT connection state.

  • `CONNECTED` - connection successful
  • `DISCONNECTED` - There is some problem with the connection
  
  
• ttnConnectionError: (string)

  Error description (if there is any problem with the TTN MQTT connection).

• kpcConnectionState: required(one of CONNECTED, DISCONNECTED)

  Tenant application integrations KPC MQTT connection state.

  • `CONNECTED` - connection successful
  • `DISCONNECTED` - There is some problem with the connection
  
  
• kpcConnectionError: (string)

  Error description (if there is any problem with the KPC MQTT connection for the tenant).

Example:

{
  "id": 351,
  "appName": "0cckq4hhhgmc6ivflvag",
  "ttnUsername": "lorawan-smart-farm2@ttn",
  "ttnIdentityServerHost": "farmtenant.eu1.cloud.thethings.industries",
  "ttnNetworkServerHost": "farmtenant.eu1.cloud.thethings.industries",
  "ttnJoinServerHost": "farmtenant.eu1.cloud.thethings.industries",
  "ttnApplicationServerHost": "farmtenant.eu1.cloud.thethings.industries",
  "ttnPlainMqttServerUrl": "eu2.cloud.thethings.industries:1883",
  "name": "Smart Farm",
  "description": "Smart farm LoRaWAN devices integration",
  "status": "ACTIVE",
  "ttnMqttIntegrationEnabled": true,
  "ttnConnectionState": "DISCONNECTED",
  "ttnConnectionError": "Unable to connect to server",
  "kpcConnectionState": "CONNECTED"
}

HTTP status code 404

Application integration not found or querying user is not authorized for it.

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

Secured by oauth_2_0

Headers

• Authorization: (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

Application integration is successfully updated.

Body

Media type: application/json

Type: object

• id: required(integer)

  Application integration unique identifier.

• appName: required(string)

  The KaaIoT platform application name.

• ttnUsername: required(string)

  The Things Network username.

• ttnIdentityServerHost: required(string)

  The Things Network Identity Server host address.

• ttnNetworkServerHost: (string)

  The Things Network (TTN) Network Server host address.

• ttnJoinServerHost: (string)

  The Things Network Join Server host address.

• ttnApplicationServerHost: (string)

  The Things Network Application Server host address.

• ttnPlainMqttServerUrl: (string)

  The Things Network MQTT Server URL address.

• ttnMqttIntegrationEnabled: required(boolean)

  Enable TTN MQTT integration MQTT. false when, for example, used Node-red for message parsing. In such a case ttnPlainMqttServerUrl not used.

• name: required(string)

  Application integration name.

• description: (string)

  Application integration description.

• status: required(one of ACTIVE, SUSPENDED)

  Application integration status.

• poolIds: (array of string)

  An array of the unique identifiers of the pools to which the application integration will be attached.

Example:

{
  "id": 267,
  "appName": "q4hhh0cckgmc6ivflvag",
  "ttnUsername": "lorawan-farm-app@ttn",
  "ttnIdentityServerHost":"eu1.cloud.thethings.network",
  "ttnJoinServerHost":"eu1.cloud.thethings.network",
  "ttnNetworkServerHost":"eu1.cloud.thethings.network",
  "ttnApplicationServerHost":"eu1.cloud.thethings.network",
  "ttnPlainMqttServerUrl": "eu1.cloud.thethings.network:1883",
  "ttnMqttIntegrationEnabled": true,
  "name": "Smart Farm",
  "description": "Smart farm LoRaWAN devices integration",
  "status": "ACTIVE"
}

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

HTTP status code 404

Application integration not found or querying user is not authorized for it.

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

Secured by oauth_2_0

Headers

• Authorization: (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

Application integration successfully deleted.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

HTTP status code 404

Application integration not found or querying user is not authorized for it.

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

Secured by oauth_2_0

Headers

• Authorization: (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 201

Device integrations are created.

Body

Media type: application/json

Type: object

• createdCount: required(integer)

  Count of device integrations with successful creation.

• failedCount: required(integer)

  Count of device integrations with failed creation.

• created: required(array of app-dev-integration-types.DevIntegrationResponse)

  Array of device integrations with successful creation.

  Items: DevIntegrationResponse

  • id: required(integer)

    Device integration unique identifier.

  • appVersionName: required(string)

    The KaaIoT platform application version name.

  • ttnDeviceId: required(string)

    The Things Network device unique identifier.

  • endpointId: required(string)

    Kaa endpoint unique identifier.

  • name: required(string)

    Device integration name.

  • description: (string)

    Device integration description.

  • status: required(one of ACTIVE, SUSPENDED)

    Device integration status.

• failed: required(array of app-dev-integration-types.DevIntegrationFailedResponse)

  Array of device integrations with failed creation.

  Items: DevIntegrationFailedResponse

  • ttnDeviceId: required(string)

    The Things Network device unique identifier.

  • reason: (string)

    Cause of failing device integration creation.

Example:

{
  "createdCount": 2,
  "failedCount": 1,
  "created": [
    {
      "id": 10,
      "appVersionName": "0cckq4hhhgmc6ivflvag-v1",
      "ttnDeviceId": "eui-1b789bc1325a5",
      "endpointId": "59126304-4970-4f80-91a1-06e9ae2b7476",
      "name": "Moisture monitor 25",
      "description": "Greenhouse 1",
      "status": "ACTIVE"
    },
    {
      "id": 25,
      "appVersionName": "0cckq4hhhgmc6ivflvag-v2",
      "ttnDeviceId": "eui-1b789bc1325a6",
      "endpointId": "59126304-4970-4f80-91a1-06e9ae2b7445",
      "name": "Moisture monitor 27",
      "description": "Greenhouse 1",
      "status": "ACTIVE"
    }
  ],
  "failed": [
    {
      "ttnDeviceId": "eui-1b789bc1325b8",
      "reason": "Can't create endpoint for appIntegrationId [303], appVersionName [0cckq4hhhgmc6ivflvag-v1]"
    }
  ]
}

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

HTTP status code 403

User does not have permissions to perform this operation.

HTTP status code 404

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

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

Secured by oauth_2_0

Headers

• Authorization: (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

Device integrations are successfully retrieved.

Body

Media type: application/json

Type: object

• 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 app-dev-integration-types.DevIntegrationResponse)

  Items: DevIntegrationResponse

  • id: required(integer)

    Device integration unique identifier.

  • appVersionName: required(string)

    The KaaIoT platform application version name.

  • ttnDeviceId: required(string)

    The Things Network device unique identifier.

  • endpointId: required(string)

    Kaa endpoint unique identifier.

  • name: required(string)

    Device integration name.

  • description: (string)

    Device integration description.

  • status: required(one of ACTIVE, SUSPENDED)

    Device integration status.

Example:

{
  "totalElements": 2,
  "content": [
    {
      "id": 10,
      "appVersionName": "0cckq4hhhgmc6ivflvag-v1",
      "ttnDeviceId": "eui-1b789bc1325a5",
      "endpointId": "59126304-4970-4f80-91a1-06e9ae2b7476",
      "name": "Moisture monitor integration 25",
      "description": "Greenhouse 1",
      "status": "ACTIVE"
    },
    {
      "id": 25,
      "appVersionName": "0cckq4hhhgmc6ivflvag-v2",
      "ttnDeviceId": "eui-1b789bc1325a6",
      "endpointId": "59126304-4970-4f80-91a1-06e9ae2b7445",
      "name": "Moisture monitor integration 28",
      "description": "Greenhouse 1",
      "status": "ACTIVE"
    }
  ]
}

HTTP status code 404

Application integration not found or querying user is not authorized for it.

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

Secured by oauth_2_0

Headers

• Authorization: (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 device integration registration task is accepted.

Body

Media type: application/json

Type: object

• taskId: required(string)

  Batch device integrations registration task ID.

Example:

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

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

• 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: (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 device integration registration task's status is successfully retrieved.

Body

Media type: application/json

Type: object

• createdCount: required(integer)

  Count of device integrations with successful registration.

• failedCount: required(integer)

  Count of device integrations with failed registration.

• created: required(array of app-dev-integration-types.BatchDevIntegrationItemCreated)

  Array of device integrations with successful registration.

  Items: BatchDevIntegrationItemCreated

  • id: required(integer)

    Device integration unique identifier.

  • devEui: required(string)

    64-bit unique device identifier in (EUI-64) that uniquely identifies the end-device (DevEUI).

  • ttnDeviceId: required(string)

    The Things Network device unique identifier.

  • appVersionName: required(string)

    The KaaIoT platform application version name.

  • endpointId: required(string)

    Endpoint ID.

  • ttnDeviceName: (string)

    TTN Device name.

  • ttnDeviceDescription: (string)

    TTN Device description.

  • name: required(string)

    Device integration name.

  • description: (string)

    Device integration description.

  • endpointMetadata: (object)

    Endpoint metadata consists of multiple key-value pairs (called fields) where keys are strings, and the values are of any JSON type.
  • endpointRelations: (array of ttnc-api-types.EndpointRelation)

    Endpoint relation with other endpoints. Only one of the directions - either to or from, must be specified in each relation entry. For example, registering an endpoint that represents a room, you can specify two entries with the relation type contains - inbound from the endpoint representing a building (from), and outbound to the endpoint representing a sensor in that room (to).

    Items: EndpointRelation

    • type: required(contains)

      Relation type.

    • from: (string)

      Endpoint ID having the outbound direction of relation type coming to the registering endpoint.

    • to: (string)

      Endpoint ID having the inbound direction of relation type coming from the registering endpoint.

• failed: required(array of app-dev-integration-types.BatchDevIntegrationItemFailed)

  Array of device integrations with failed registration.

  Items: BatchDevIntegrationItemFailed

  • devEui: required(string)

    64-bit unique device identifier in (EUI-64) that uniquely identifies the end-device (DevEUI).

  • reason: (string)

    Cause of failing device integration creation.

Example:

{
  "createdCount": 2,
  "failedCount": 1,
  "created": [
    {
      "id": 124,
      "devEui": "1B789BC1325A5",
      "ttnDeviceId": "eui-1b789bc1325a5",
      "appVersionName": "example_app_v1",
      "endpointId": "56726466-e454-23ac-340c-f34fefda7de4",
      "ttnDeviceName": "Moisture sensor 25",
      "ttnDeviceDescription": "Greenhouse 1",
      "name": "device-25",
      "endpointMetadata": {
        "name": "LoRa moisture sensor 25",
        "serial": "AC53743462-34"
      },
      "endpointRelations": [
        {
          "type": "contains",
          "to": "f359de38-6763-11ed-9022-0242ac120002"
        },
        {
          "type": "contains",
          "from": "518ab0c0-e505-4062-9f1f-408da7b3ea05"
        }
      ]
    },
    {
      "id": 125,
      "devEui": "1B789BC1325A8",
      "ttnDeviceId": "eui-1b789bc1325a8",
      "appVersionName": "example_app_v1",
      "endpointId": "56726466-e454-23ac-340c-f34fefda7df2",
      "ttnDeviceName": "Moisture sensor 28",
      "ttnDeviceDescription": "Greenhouse 1",
      "name": "device-28",
      "endpointMetadata": {
        "name": "LoRa moisture sensor 28",
        "serial": "AC53743462-37"
      }
    }
  ],
  "failed": [
    {
      "devEui": "1B789BC1325A2",
      "reason": "Device integration for the specified device EUI already exists."
    }
  ]
}

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

Secured by oauth_2_0

Headers

• Authorization: (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

Device integration is successfully retrieved.

Body

Media type: application/json

Type: object

• id: required(integer)

  Device integration unique identifier.

• appVersionName: required(string)

  The KaaIoT platform application version name.

• ttnDeviceId: required(string)

  The Things Network device unique identifier.

• endpointId: required(string)

  Kaa endpoint unique identifier.

• name: required(string)

  Device integration name.

• description: (string)

  Device integration description.

• endpointMetadata: (object)

  Endpoint metadata consists of multiple key-value pairs (called fields) where keys are strings, and the values are of any JSON type.
• endpointRelations: (array of ttnc-api-types.EndpointRelation)

  Endpoint relation with other endpoints. Only one of the directions - either to or from, must be specified in each relation entry. For example, registering an endpoint that represents a room, you can specify two entries with the relation type contains - inbound from the endpoint representing a building (from), and outbound to the endpoint representing a sensor in that room (to).

  Items: EndpointRelation

  • type: required(contains)

    Relation type.

  • from: (string)

    Endpoint ID having the outbound direction of relation type coming to the registering endpoint.

  • to: (string)

    Endpoint ID having the inbound direction of relation type coming from the registering endpoint.

• status: required(one of ACTIVE, SUSPENDED)

  Device integration status.

Example:

{
  "id": 10,
  "appVersionName": "0cckq4hhhgmc6ivflvag-v1",
  "ttnDeviceId": "eui-1b789bc1325a5",
  "endpointId": "59126304-4970-4f80-91a1-06e9ae2b7476",
  "name": "Moisture monitor integration 25",
  "description": "Greenhouse 1",
  "endpointMetadata": {
    "name": "LoRa moisture sensor 25",
    "serial": "AC53743462-34"
  },
  "endpointRelations": [
    {
      "type": "contains",
      "to": "f359de38-6763-11ed-9022-0242ac120002"
    },
    {
      "type": "contains",
      "from": "518ab0c0-e505-4062-9f1f-408da7b3ea05"
    }
  ],
  "status": "ACTIVE"
}

HTTP status code 404

Device integration not found or querying user is not authorized for it.

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

Secured by oauth_2_0

Headers

• Authorization: (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

Device integration is successfully updated.

Body

Media type: application/json

Type: object

• id: required(integer)

  Device integration unique identifier.

• appVersionName: required(string)

  The KaaIoT platform application version name.

• ttnDeviceId: required(string)

  The Things Network device unique identifier.

• endpointId: required(string)

  Kaa endpoint unique identifier.

• name: required(string)

  Device integration name.

• description: (string)

  Device integration description.

• endpointMetadata: (object)

  Endpoint metadata consists of multiple key-value pairs (called fields) where keys are strings, and the values are of any JSON type.
• endpointRelations: (array of ttnc-api-types.EndpointRelation)

  Endpoint relation with other endpoints. Only one of the directions - either to or from, must be specified in each relation entry. For example, registering an endpoint that represents a room, you can specify two entries with the relation type contains - inbound from the endpoint representing a building (from), and outbound to the endpoint representing a sensor in that room (to).

  Items: EndpointRelation

  • type: required(contains)

    Relation type.

  • from: (string)

    Endpoint ID having the outbound direction of relation type coming to the registering endpoint.

  • to: (string)

    Endpoint ID having the inbound direction of relation type coming from the registering endpoint.

• status: required(one of ACTIVE, SUSPENDED)

  Device integration status.

Example:

{
  "id": 10,
  "appVersionName": "0cckq4hhhgmc6ivflvag-v1",
  "ttnDeviceId": "eui-1b789bc1325a5",
  "endpointId": "59126304-4970-4f80-91a1-06e9ae2b7476",
  "name": "Moisture monitor integration 25",
  "description": "Greenhouse 1",
  "endpointMetadata": {
    "name": "LoRa moisture sensor 25",
    "serial": "AC53743462-34"
  },
  "endpointRelations": [
    {
      "type": "contains",
      "to": "f359de38-6763-11ed-9022-0242ac120002"
    },
    {
      "type": "contains",
      "from": "518ab0c0-e505-4062-9f1f-408da7b3ea05"
    }
  ],
  "status": "ACTIVE"
}

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

HTTP status code 404

Device integration not found or querying user is not authorized for it.

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

Secured by oauth_2_0

Headers

• Authorization: (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

Device integration status is successfully updated.

HTTP status code 404

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

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

Secured by oauth_2_0

Headers

• Authorization: (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 201

Account integration was successfully created.

Headers

• Location: required(string)

  URI in format {schema}://{host}:{port}/api/v1/gateway-integrations/{id}

  Example:

  http://example.com/api/v1/account-integrations/25

Body

Media type: application/json

Type: object

• id: required(integer)

  Account integration unique identifier.

• appName: required(string)

  The KaaIoT platform application name.

• ttnUserId: required(string)

  The Things Network user ID.

• ttnIdentityServerHost: required(string)

  The Things Network Identity Server host address.

• name: required(string)

  Account integration name.

• description: (string)

  Account integration description.

• status: required(one of ACTIVE, SUSPENDED)

  Account integration status.

• error: (string)

  Error description (if there is any problem with the TTN or KPC connection).

Example:

{
  "id": 25,
  "appName": "q4hhh0cckgmvagc6ivfl",
  "ttnUserId": "farm-industry",
  "ttnIdentityServerHost": "eu1.cloud.thethings.network",
  "name": "Smart Farm gateways",
  "description": "Smart farm LoRaWAN gateways integration",
  "status": "ACTIVE"
}

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

• 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: (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

Account integrations are successfully retrieved.

Body

Media type: application/json

Type: object

• 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 account-gateway-integration-types.AccountIntegrationResponse)

  Items: AccountIntegrationResponse

  • id: required(integer)

    Account integration unique identifier.

  • appName: required(string)

    The KaaIoT platform application name.

  • ttnUserId: required(string)

    The Things Network user ID.

  • ttnIdentityServerHost: required(string)

    The Things Network Identity Server host address.

  • name: required(string)

    Account integration name.

  • description: (string)

    Account integration description.

  • status: required(one of ACTIVE, SUSPENDED)

    Account integration status.

  • error: (string)

    Error description (if there is any problem with the TTN or KPC connection).

Example:

{
  "totalElements": 1,
  "content": [
    {
      "id": 25,
      "appName": "q4hhh0cckgmvagc6ivfl",
      "ttnUserId": "farm-industry",
      "ttnIdentityServerHost": "eu1.cloud.thethings.network",
      "name": "Smart Farm gateways",
      "description": "Smart farm LoRaWAN gateways integration",
      "status": "ACTIVE"
    }
  ]
}

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

Secured by oauth_2_0

Headers

• Authorization: (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

Account integration is successfully retrieved.

Body

Media type: application/json

Type: object

• id: required(integer)

  Account integration unique identifier.

• appName: required(string)

  The KaaIoT platform application name.

• ttnUserId: required(string)

  The Things Network user ID.

• ttnIdentityServerHost: required(string)

  The Things Network Identity Server host address.

• name: required(string)

  Account integration name.

• description: (string)

  Account integration description.

• status: required(one of ACTIVE, SUSPENDED)

  Account integration status.

• error: (string)

  Error description (if there is any problem with the TTN or KPC connection).

Example:

{
  "id": 25,
  "appName": "q4hhh0cckgmvagc6ivfl",
  "ttnUserId": "farm-industry",
  "ttnIdentityServerHost": "eu1.cloud.thethings.network",
  "name": "Smart Farm gateways",
  "description": "Smart farm LoRaWAN gateways integration",
  "status": "ACTIVE"
}

HTTP status code 404

Account integration not found or querying user is not authorized for it.

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

Secured by oauth_2_0

Headers

• Authorization: (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

Account integration is successfully updated.

Body

Media type: application/json

Type: object

• id: required(integer)

  Account integration unique identifier.

• appName: required(string)

  The KaaIoT platform application name.

• ttnUserId: required(string)

  The Things Network user ID.

• ttnIdentityServerHost: required(string)

  The Things Network Identity Server host address.

• name: required(string)

  Account integration name.

• description: (string)

  Account integration description.

• status: required(one of ACTIVE, SUSPENDED)

  Account integration status.

• error: (string)

  Error description (if there is any problem with the TTN or KPC connection).

Example:

{
  "id": 25,
  "appName": "q4hhh0cckgmvagc6ivfl",
  "ttnUserId": "farm-industry",
  "ttnIdentityServerHost": "eu1.cloud.thethings.network",
  "name": "Smart Farm gateways",
  "description": "Smart farm LoRaWAN gateways integration",
  "status": "ACTIVE"
}

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

HTTP status code 404

Account integration not found or querying user is not authorized for it.

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

Secured by oauth_2_0

Headers

• Authorization: (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

Account integration successfully deleted.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

HTTP status code 404

Account integration not found or querying user is not authorized for it.

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

Secured by oauth_2_0

Headers

• Authorization: (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 201

Gateway integrations are created.

Body

Media type: application/json

Type: object

• createdCount: required(integer)

  Count of gateway integrations with successful creation.

• failedCount: required(integer)

  Count of gateway integrations with failed creation.

• created: required(array of account-gateway-integration-types.GatewayIntegrationResponse)

  Array of gateway integrations with successful creation.

  Items: GatewayIntegrationResponse

  • id: required(integer)

    The KaaIoT platform gateway integration unique identifier.

  • appVersionName: required(string)

    The KaaIoT platform application version name.

  • ttnGatewayId: required(string)

    The Things Network gateway unique identifier.

  • endpointId: required(string)

    The KaaIoT endpoint unique identifier.

  • name: required(string)

    The KaaIoT platform gateway integration name.
    The human readable name to help identify the gateway integration.

  • description: (string)

    The KaaIoT platform gateway integration description.

  • endpointMetadata: (object)

    Endpoint metadata consists of multiple key-value pairs (called fields) where keys are strings, and the values are of any JSON type.
  • endpointRelations: (array of ttnc-api-types.EndpointRelation)

    Endpoint relation with other endpoints. Only one of the directions - either to or from, must be specified in each relation entry. For example, registering an endpoint that represents a room, you can specify two entries with the relation type contains - inbound from the endpoint representing a building (from), and outbound to the endpoint representing a sensor in that room (to).

    Items: EndpointRelation

    • type: required(contains)

      Relation type.

    • from: (string)

      Endpoint ID having the outbound direction of relation type coming to the registering endpoint.

    • to: (string)

      Endpoint ID having the inbound direction of relation type coming from the registering endpoint.

  • ttnGatewayInfo: (object)

    Gateway information to register on The Things Network.

    • ttnGatewayEui: required(string)

      The Things Network gateway EUI. A 64 bit extended unique identifier for your gateway. It should be provided to you by the manufacturer, or printed on the gateway package.

    • ttnGatewayName: (string)

      The Things Network gateway name. An optional human readable name to help identify your gateway.

    • frequencyPlanId: required(string)

      The Things Network ID of the frequency plan used by this device. https://www.thethingsindustries.com/docs/reference/frequency-plans/

    • statusPublic: (boolean - default: false)

      The status of this gateway may be publicly displayed.

    • locationPublic: (boolean - default: false)

      The location of this gateway may be publicly displayed.

    • gatewayServerAddress: required(string)

      The address of the Gateway Server to connect to.

    • enforceDutyCycle: (boolean - default: true)

      Enforcing gateway duty cycle is recommended for all gateways to respect spectrum regulations. Disable enforcing the duty cycle only in controlled research and development environments.

    • scheduleAnytimeDelay: (number - default: 0.53)

      Adjust the time that GS schedules class C messages in advance. This is useful for gateways that have a known high latency backhaul, like 3G and satellite.

  • status: required(one of ACTIVE, SUSPENDED)

    Gateway integration status.

• failed: required(array of account-gateway-integration-types.GatewayIntegrationFailedResponse)

  Array of gateway integrations with failed creation.

  Items: GatewayIntegrationFailedResponse

  • ttnGatewayId: required(string)

    The Things Network gateway unique identifier.

  • reason: (string)

    Cause of failing gateway integration creation.

Example:

{
  "createdCount": 1,
  "failedCount": 1,
  "created": [
    {
      "id": 10,
      "appVersionName": "0cckq4hhhgmc6ivflvag-v1",
      "ttnGatewayId": "eui-1b789bc1325a5",
      "endpointId": "59126304-4970-4f80-91a1-06e9ae2b7476",
      "name": "Farm 1 gateway",
      "description": "Greenhouse 1",
      "endpointMetadata": {
        "name": "LoRa farm gateway 1",
        "serial": "GA53627434"
      },
      "endpointRelations": [
        {
          "type": "contains",
          "to": "f359de38-6763-11ed-9022-0242ac120002"
        },
        {
          "type": "contains",
          "from": "518ab0c0-e505-4062-9f1f-408da7b3ea05"
        }
      ],
      "ttnGatewayInfo": {
        "ttnGatewayEui": "70B04A33D57ED0F3",
        "ttnGatewayName": "Farm 1 gateway",
        "frequencyPlanId": "EU_863_870_TTN",
        "statusPublic": true,
        "locationPublic": false,
        "gatewayServerAddress": "farmtenant.eu1.cloud.thethings.industries",
        "enforceDutyCycle": false,
        "scheduleAnytimeDelay": 0.5
      },
      "status": "ACTIVE"
    }
  ],
  "failed": [
    {
      "ttnGatewayId": "eui-1b789bc1325b8",
      "reason": "Can't create endpoint for gatewayIntegrationId [303], appVersionName [0cckq4hhhgmc6ivflvag-v1]"
    }
  ]
}

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

HTTP status code 403

User does not have permissions to perform this operation.

HTTP status code 404

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

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

Secured by oauth_2_0

Headers

• Authorization: (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

Gateway integrations are successfully retrieved.

Body

Media type: application/json

Type: object

• 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 account-gateway-integration-types.GatewayIntegrationResponse)

  Items: GatewayIntegrationResponse

  • id: required(integer)

    The KaaIoT platform gateway integration unique identifier.

  • appVersionName: required(string)

    The KaaIoT platform application version name.

  • ttnGatewayId: required(string)

    The Things Network gateway unique identifier.

  • endpointId: required(string)

    The KaaIoT endpoint unique identifier.

  • name: required(string)

    The KaaIoT platform gateway integration name.
    The human readable name to help identify the gateway integration.

  • description: (string)

    The KaaIoT platform gateway integration description.

  • endpointMetadata: (object)

    Endpoint metadata consists of multiple key-value pairs (called fields) where keys are strings, and the values are of any JSON type.
  • endpointRelations: (array of ttnc-api-types.EndpointRelation)

    Endpoint relation with other endpoints. Only one of the directions - either to or from, must be specified in each relation entry. For example, registering an endpoint that represents a room, you can specify two entries with the relation type contains - inbound from the endpoint representing a building (from), and outbound to the endpoint representing a sensor in that room (to).

    Items: EndpointRelation

    • type: required(contains)

      Relation type.

    • from: (string)

      Endpoint ID having the outbound direction of relation type coming to the registering endpoint.

    • to: (string)

      Endpoint ID having the inbound direction of relation type coming from the registering endpoint.

  • ttnGatewayInfo: (object)

    Gateway information to register on The Things Network.

    • ttnGatewayEui: required(string)

      The Things Network gateway EUI. A 64 bit extended unique identifier for your gateway. It should be provided to you by the manufacturer, or printed on the gateway package.

    • ttnGatewayName: (string)

      The Things Network gateway name. An optional human readable name to help identify your gateway.

    • frequencyPlanId: required(string)

      The Things Network ID of the frequency plan used by this device. https://www.thethingsindustries.com/docs/reference/frequency-plans/

    • statusPublic: (boolean - default: false)

      The status of this gateway may be publicly displayed.

    • locationPublic: (boolean - default: false)

      The location of this gateway may be publicly displayed.

    • gatewayServerAddress: required(string)

      The address of the Gateway Server to connect to.

    • enforceDutyCycle: (boolean - default: true)

      Enforcing gateway duty cycle is recommended for all gateways to respect spectrum regulations. Disable enforcing the duty cycle only in controlled research and development environments.

    • scheduleAnytimeDelay: (number - default: 0.53)

      Adjust the time that GS schedules class C messages in advance. This is useful for gateways that have a known high latency backhaul, like 3G and satellite.

  • status: required(one of ACTIVE, SUSPENDED)

    Gateway integration status.

Example:

{
  "totalElements": 1,
  "content": [
    {
      "id": 10,
      "appVersionName": "0cckq4hhhgmc6ivflvag-v1",
      "ttnGatewayId": "dranginotest",
      "endpointId": "59126304-4970-4f80-91a1-06e9ae2b7476",
      "name": "Moisture monitor 1",
      "description": "",
      "endpointMetadata": {
        "name": "LoRa farm gateway 1",
        "serial": "GA53627434"
      },
      "endpointRelations": [
        {
          "type": "contains",
          "to": "f359de38-6763-11ed-9022-0242ac120002"
        },
        {
          "type": "contains",
          "from": "518ab0c0-e505-4062-9f1f-408da7b3ea05"
        }
      ],
      "ttnGatewayInfo": {
        "ttnGatewayEui": "70B04A33D57ED0F3",
        "ttnGatewayName": "Farm 1 gateway",
        "frequencyPlanId": "EU_863_870_TTN",
        "statusPublic": true,
        "locationPublic": false,
        "gatewayServerAddress": "farmtenant.eu1.cloud.thethings.industries",
        "enforceDutyCycle": false,
        "scheduleAnytimeDelay": 0.5
      },
      "status": "ACTIVE"
    }
  ]
}

HTTP status code 404

Account integration not found or querying user is not authorized for it.

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

Secured by oauth_2_0

Headers

• Authorization: (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

Gateway integration is successfully updated.

Body

Media type: application/json

Type: object

• id: required(integer)

  The KaaIoT platform gateway integration unique identifier.

• appVersionName: required(string)

  The KaaIoT platform application version name.

• ttnGatewayId: required(string)

  The Things Network gateway unique identifier.

• endpointId: required(string)

  The KaaIoT endpoint unique identifier.

• name: required(string)

  The KaaIoT platform gateway integration name.
  The human readable name to help identify the gateway integration.

• description: (string)

  The KaaIoT platform gateway integration description.

• endpointMetadata: (object)

  Endpoint metadata consists of multiple key-value pairs (called fields) where keys are strings, and the values are of any JSON type.
• endpointRelations: (array of ttnc-api-types.EndpointRelation)

  Endpoint relation with other endpoints. Only one of the directions - either to or from, must be specified in each relation entry. For example, registering an endpoint that represents a room, you can specify two entries with the relation type contains - inbound from the endpoint representing a building (from), and outbound to the endpoint representing a sensor in that room (to).

  Items: EndpointRelation

  • type: required(contains)

    Relation type.

  • from: (string)

    Endpoint ID having the outbound direction of relation type coming to the registering endpoint.

  • to: (string)

    Endpoint ID having the inbound direction of relation type coming from the registering endpoint.

• ttnGatewayInfo: (object)

  Gateway information to register on The Things Network.

  • ttnGatewayEui: required(string)

    The Things Network gateway EUI. A 64 bit extended unique identifier for your gateway. It should be provided to you by the manufacturer, or printed on the gateway package.

  • ttnGatewayName: (string)

    The Things Network gateway name. An optional human readable name to help identify your gateway.

  • frequencyPlanId: required(string)

    The Things Network ID of the frequency plan used by this device. https://www.thethingsindustries.com/docs/reference/frequency-plans/

  • statusPublic: (boolean - default: false)

    The status of this gateway may be publicly displayed.

  • locationPublic: (boolean - default: false)

    The location of this gateway may be publicly displayed.

  • gatewayServerAddress: required(string)

    The address of the Gateway Server to connect to.

  • enforceDutyCycle: (boolean - default: true)

    Enforcing gateway duty cycle is recommended for all gateways to respect spectrum regulations. Disable enforcing the duty cycle only in controlled research and development environments.

  • scheduleAnytimeDelay: (number - default: 0.53)

    Adjust the time that GS schedules class C messages in advance. This is useful for gateways that have a known high latency backhaul, like 3G and satellite.

• status: required(one of ACTIVE, SUSPENDED)

  Gateway integration status.

Example:

{
  "id": 102,
  "appVersionName": "0cckq4hhhgmc6ivflvag-v1",
  "ttnGatewayId": "dranginotest",
  "endpointId": "59126304-4970-4f80-91a1-06e9ae2b7476",
  "name": "Moisture monitor 1",
  "description": "",
  "endpointMetadata": {
    "name": "LoRa farm gateway 1",
    "serial": "GA53627434"
  },
  "endpointRelations": [
    {
      "type": "contains",
      "to": "f359de38-6763-11ed-9022-0242ac120002"
    },
    {
      "type": "contains",
      "from": "518ab0c0-e505-4062-9f1f-408da7b3ea05"
    }
  ],
  "ttnGatewayInfo": {
    "ttnGatewayEui": "70B04A33D57ED0F3",
    "ttnGatewayName": "Farm 1 gateway",
    "frequencyPlanId": "EU_863_870_TTN",
    "statusPublic": true,
    "locationPublic": false,
    "gatewayServerAddress": "farmtenant.eu1.cloud.thethings.industries",
    "enforceDutyCycle": false,
    "scheduleAnytimeDelay": 0.5
  },
  "status": "ACTIVE"
}

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

HTTP status code 404

Gateway integration not found or querying user is not authorized for it.

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

Secured by oauth_2_0

Headers

• Authorization: (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

Gateway integration status is successfully updated.

HTTP status code 404

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

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

Secured by oauth_2_0

Headers

• Authorization: (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

TTN application is successfully retrieved.

Body

Media type: application/json

Type: object

• applicationId: required(string)

  The Things Network application unique identifier.

• createdAt: required(datetime)

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

• updatedAt: required(datetime)

  Timestamp in ISO 8601 format (UTC timezone) showing when the application was updated.

• name: required(string)

  The Things Network application name.

• description: (string)

  The Things Network application description.

• attributes: (object)

  The Things Network application attributes. Application attributes consist of multiple key-value pairs <string, string>.

Example:

{
  "applicationId": "farm-app-id",
  "createdAt": "2021-12-20T14:07:10.599Z",
  "updatedAt": "2022-02-01T14:00:19.911Z",
  "name": "Farm application",
  "description": "Farm sensors"
}

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

HTTP status code 200

TTN devices are successfully retrieved.

Body

Media type: application/json

Type: array of object

Items: TtnDeviceResponse

Example:

[
  {
    "deviceId":  "eui-70b3d57ed004a3f3",
    "applicationId": "ttn-app-id",
    "deviceEui": "70B3D57ED004A3F3",
    "joinEui": "D004A3F370B3D57E",
    "createdAt": "2021-12-20T14:07:10.599Z",
    "updatedAt": "2022-02-01T14:00:19.911Z",
    "name": "Room",
    "description": "Room temperature sensor",
    "attributes": {
      "alarm": "on"
    },
    "location": {
      "latitude": 51.49426750477876,
      "longitude": 31.29522889852524,
      "altitude": 20.0,
      "source": "SOURCE_REGISTRY"
    }
  },
  {
    "deviceId":  "eui-70b3d57ed004a3f5",
    "applicationId": "ttn-app-id",
    "deviceEui": "70B3D57ED004A3F5",
    "joinEui": "D004A3F370B3D57E",
    "createdAt": "2021-12-20T14:07:10.599Z",
    "updatedAt": "2022-02-01T14:00:19.911Z",
    "name": "Kitchen"
  }
]

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

HTTP status code 404

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

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

Secured by oauth_2_0

Headers

• Authorization: (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

TTN gateways are successfully retrieved.

Body

Media type: application/json

Type: array of object

Items: TtnGatewaysResponse

Example:

[
  {
    "gatewayId":  "dranginotest",
    "gatewayEui": "A8FF241DCFF1AC40",
    "name": "gateway-dragino-1",
    "createdAt": "2022-04-27T15:14:37.254Z",
    "updatedAt": "2023-01-17T09:06:26.106581Z",
    "gatewayServerAddress": "eu1.cloud.thethings.network",
    "frequencyPlanId": "EU_863_870_TTN"
  },
  {
    "gatewayId":  "eui-70b3d57ed004a3f3",
    "gatewayEui": "70B3D57ED004A3F3",
    "name": "gateway-dragino-2",
    "createdAt": "2022-09-14T11:58:59.959263Z",
    "updatedAt": "2022-10-17T10:48:07.862799Z"
  }
]

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

HTTP status code 404

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

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.

Secured by oauth_2_0

Headers

• Authorization: (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

Credencials are successfully verified.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

• message: required(string)

  Detailed error description.