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)

  Kaa platform application name.

• ttnUsername: required(string)

  The Things Network username.

• ttnIdentityServerHost: required(string)

  The Things Network Identity Server host address.

• ttnPlainMqttServerUrl: required(string)

  The Things Network MQTT Server URL address.

• name: required(string)

  Application integration name.

• description: (string)

  Application integration description.

• status: required(one of ACTIVE, SUSPENDED)

  Application integration status.

Example:

{
  "id": 267,
  "appName": "q4hhh0cckgmc6ivflvag",
  "ttnUsername": "lorawan-farm-app@ttn",
  "ttnIdentityServerHost": "eu1.cloud.thethings.network",
  "ttnPlainMqttServerUrl": "eu1.cloud.thethings.network:1883",
  "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.AppIntegrationExtResponse)

  Items: AppIntegrationExtResponse

  • id: required(integer)

    Application integration unique identifier.

  • appName: required(string)

    Kaa platform application name.

  • ttnUsername: required(string)

    The Things Network username.

  • ttnIdentityServerHost: required(string)

    The Things Network Identity Server host address.

  • ttnPlainMqttServerUrl: required(string)

    The Things Network MQTT Server URL address.

  • name: required(string)

    Application integration name.

  • description: (string)

    Application integration description.

  • status: required(one of ACTIVE, SUSPENDED)

    Application integration status.

  • state: required(one of CONNECTED, DISCONNECTED)

    Application integration TTN MQTT connection state.

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

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

Example:

{
  "totalElements": 2,
  "content": [
    {
      "id": 267,
      "appName": "q4hhh0cckgmc6ivflvag",
      "ttnUsername": "lorawan-smart-farm@ttn",
      "ttnIdentityServerHost": "eu1.cloud.thethings.network",
      "ttnPlainMqttServerUrl": "eu1.cloud.thethings.network:1883",
      "name": "Smart Farm",
      "description": "Smart farm LoRaWAN devices integration",
      "status": "ACTIVE",
      "state": "CONNECTED"
    },
    {
      "id": 351,
      "appName": "0cckq4hhhgmc6ivflasd",
      "ttnUsername": "lorawan-smart-farm2@ttn",
      "ttnIdentityServerHost": "farmtenant.eu1.cloud.thethings.industries",
      "ttnPlainMqttServerUrl": "eu2.cloud.thethings.industries:1883",
      "name": "Smart Farm",
      "description": "Smart farm LoRaWAN devices integration",
      "status": "SUSPENDED",
      "state": "DISCONNECTED",
      "error": "Not authorized to connect"
    }
  ]
}

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)

  Kaa platform application name.

• ttnUsername: required(string)

  The Things Network username.

• ttnIdentityServerHost: required(string)

  The Things Network Identity Server host address.

• ttnPlainMqttServerUrl: required(string)

  The Things Network MQTT Server URL address.

• name: required(string)

  Application integration name.

• description: (string)

  Application integration description.

• status: required(one of ACTIVE, SUSPENDED)

  Application integration status.

• state: required(one of CONNECTED, DISCONNECTED)

  Application integration TTN MQTT connection state.

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

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

• devices: required(array of app-dev-integration-types.DeviceIntegrationResponse)

  List of already integrated devices.

  Items: DeviceIntegrationResponse

  • id: required(integer)

    Device integration unique identifier.

  • appVersionName: required(string)

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

{
  "id": 351,
  "appName": "0cckq4hhhgmc6ivflvag",
  "ttnUsername": "lorawan-smart-farm2@ttn",
  "ttnIdentityServerHost": "farmtenant.eu1.cloud.thethings.industries",
  "ttnPlainMqttServerUrl": "eu2.cloud.thethings.industries:1883",
  "name": "Smart Farm",
  "description": "Smart farm LoRaWAN devices integration",
  "state": "DISCONNECTED",
  "error": "Unable to connect to server",
  "status": "ACTIVE",
  "devices": [
    {
      "id": 102,
      "appVersionName": "0cckq4hhhgmc6ivflvag-v1",
      "ttnDeviceId": "eui-1b789bc1325a5",
      "endpointId": "59126304-4970-4f80-91a1-06e9ae2b7476",
      "name": "Moisture monitor 1"
    },
    {
      "id": 105,
      "appVersionName": "0cckq4hhhgmc6ivflvag-v2",
      "ttnDeviceId": "eui-1b789bc1325a6",
      "endpointId": "78126304-4970-4f80-91a1-06e9ae2b7445",
      "name": "Moisture monitor 2"
    }
  ]
}

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)

  Kaa platform application name.

• ttnUsername: required(string)

  The Things Network username.

• ttnIdentityServerHost: required(string)

  The Things Network Identity Server host address.

• ttnPlainMqttServerUrl: required(string)

  The Things Network MQTT Server URL address.

• name: required(string)

  Application integration name.

• description: (string)

  Application integration description.

• status: required(one of ACTIVE, SUSPENDED)

  Application integration status.

Example:

{
  "id": 267,
  "appName": "q4hhh0cckgmc6ivflvag",
  "ttnUsername": "lorawan-farm-app@ttn",
  "ttnIdentityServerHost": "eu1.cloud.thethings.network",
  "ttnPlainMqttServerUrl": "eu1.cloud.thethings.network:1883",
  "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.DeviceIntegrationResponse)

  Array of device integrations with successful creation.

  Items: DeviceIntegrationResponse

  • id: required(integer)

    Device integration unique identifier.

  • appVersionName: required(string)

    Kaa 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.DeviceIntegrationFailedResponse)

  Array of device integrations with failed creation.

  Items: DeviceIntegrationFailedResponse

  • ttnDeviceId: required(string)

    The Things Network device unique identifier.

  • statusReason: (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 1",
      "description": "Greenhouse 1",
      "status": "ACTIVE"
    },
    {
      "id": 25,
      "appVersionName": "0cckq4hhhgmc6ivflvag-v2",
      "ttnDeviceId": "eui-1b789bc1325a6",
      "endpointId": "59126304-4970-4f80-91a1-06e9ae2b7445",
      "name": "Moisture monitor 2",
      "description": "Greenhouse 1",
      "status": "ACTIVE"
    }
  ],
  "failed": [
    {
      "ttnDeviceId": "eui-1b789bc1325b8",
      "statusReason": "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.DeviceIntegrationResponse)

  Items: DeviceIntegrationResponse

  • id: required(integer)

    Device integration unique identifier.

  • appVersionName: required(string)

    Kaa 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 1",
      "description": "Greenhouse 1",
      "status": "ACTIVE"
    },
    {
      "id": 25,
      "appVersionName": "0cckq4hhhgmc6ivflvag-v2",
      "ttnDeviceId": "eui-1b789bc1325a6",
      "endpointId": "59126304-4970-4f80-91a1-06e9ae2b7445",
      "name": "Moisture monitor 2",
      "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 200

Device integration is successfully updated.

Body

Media type: application/json

Type: object

• id: required(integer)

  Device integration unique identifier.

• appVersionName: required(string)

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

{
  "id": 10,
  "appVersionName": "0cckq4hhhgmc6ivflvag-v1",
  "ttnDeviceId": "eui-1b789bc1325a5",
  "endpointId": "59126304-4970-4f80-91a1-06e9ae2b7476",
  "name": "Moisture monitor",
  "description": "Greenhouse 1",
  "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)

  Kaa platform application name.

• 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.

Example:

{
  "id": 25,
  "appName": "q4hhh0cckgmvagc6ivfl",
  "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)

    Kaa platform application name.

  • 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.

Example:

{
  "totalElements": 1,
  "content": [
    {
      "id": 25,
      "appName": "q4hhh0cckgmvagc6ivfl",
      "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)

  Kaa platform application name.

• 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 connection).

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

  List of already integrated gateways.

  Items: GatewayIntegrationResponse

  • id: required(integer)

    Gateway integration unique identifier.

  • appVersionName: required(string)

    Kaa platform application version name.

  • gatewayId: required(string)

    The Things Network gateway unique identifier.

  • endpointId: required(string)

    Kaa endpoint unique identifier.

  • name: required(string)

    Gateway integration name.

  • description: (string)

    Gateway integration description.

  • status: required(one of ACTIVE, SUSPENDED)

    Gateway integration status.

Example:

{
  "id": 254,
  "appName": "0cckq4hhhgmc6ivflvag",
  "ttnUsername": "lorawan-smart-farm2@ttn",
  "ttnIdentityServerHost": "farmtenant.eu1.cloud.thethings.industries",
  "name": "Smart Farm",
  "description": "Smart farm LoRaWAN devices integration",
  "status": "ACTIVE",
  "gateways": [
    {
      "id": 102,
      "appVersionName": "0cckq4hhhgmc6ivflvag-v1",
      "ttnGatewayId": "dranginotest",
      "endpointId": "59126304-4970-4f80-91a1-06e9ae2b7476",
      "name": "Moisture monitor 1",
      "description": "",
      "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)

  Kaa platform application name.

• 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.

Example:

{
  "id": 25,
  "appName": "q4hhh0cckgmvagc6ivfl",
  "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)

    Gateway integration unique identifier.

  • appVersionName: required(string)

    Kaa platform application version name.

  • gatewayId: required(string)

    The Things Network gateway unique identifier.

  • endpointId: required(string)

    Kaa endpoint unique identifier.

  • name: required(string)

    Gateway integration name.

  • description: (string)

    Gateway integration description.

  • 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.

  • statusReason: (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",
      "status": "ACTIVE"
    }
  ],
  "failed": [
    {
      "ttnGatewayId": "eui-1b789bc1325b8",
      "statusReason": "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)

    Gateway integration unique identifier.

  • appVersionName: required(string)

    Kaa platform application version name.

  • gatewayId: required(string)

    The Things Network gateway unique identifier.

  • endpointId: required(string)

    Kaa endpoint unique identifier.

  • name: required(string)

    Gateway integration name.

  • description: (string)

    Gateway integration description.

  • 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": "",
      "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)

  Gateway integration unique identifier.

• appVersionName: required(string)

  Kaa platform application version name.

• gatewayId: required(string)

  The Things Network gateway unique identifier.

• endpointId: required(string)

  Kaa endpoint unique identifier.

• name: required(string)

  Gateway integration name.

• description: (string)

  Gateway integration description.

• 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": "",
  "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",
    "created_at": "2022-04-27T15:14:37.254Z",
    "updated_at": "2023-01-17T09:06:26.106581Z"
  },
  {
    "gatewayId":  "eui-70b3d57ed004a3f3",
    "gatewayEui": "70B3D57ED004A3F3",
    "created_at": "2022-09-14T11:58:59.959263Z",
    "updated_at": "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.