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

Properties

• 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: optional (string)

  Account integration description.

• status: required(one of ACTIVE, SUSPENDED)

  Account integration status.

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

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

Account integrations are successfully retrieved.

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 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: optional (string)

    Account integration description.

  • status: required(one of ACTIVE, SUSPENDED)

    Account integration status.

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

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

Account integration is successfully retrieved.

Body

Media type: application/json

Type: object

Properties

• 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: optional (string)

  Account integration description.

• status: required(one of ACTIVE, SUSPENDED)

  Account integration status.

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

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

Account integration is successfully updated.

Body

Media type: application/json

Type: object

Properties

• 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: optional (string)

  Account integration description.

• status: required(one of ACTIVE, SUSPENDED)

  Account integration status.

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

Properties

• 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

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 204

Account integration successfully deleted.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

• 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

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 201

Gateway integrations are created.

Body

Media type: application/json

Type: object

Properties

• createdCount: required(integer)

  Count of gateway integrations with successful creation.

• failedCount: required(integer)

  Count of gateway integrations with failed creation.

• created: required(array of 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: optional (string)

    The KaaIoT platform gateway integration description.

  • endpointMetadata: optional (object)

    Endpoint metadata consists of multiple key-value pairs (called fields) where keys are strings, and the values are of any JSON type.
  • endpointRelations: optional (array of 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: optional (string)

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

    • to: optional (string)

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

  • ttnGatewayInfo: optional (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: optional (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: optional (boolean - default: false)

      The status of this gateway may be publicly displayed.

    • locationPublic: optional (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: optional (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: optional (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 GatewayIntegrationFailedResponse)

  Array of gateway integrations with failed creation.

  Items: GatewayIntegrationFailedResponse

  • ttnGatewayId: required(string)

    The Things Network gateway unique identifier.

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

Properties

• 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

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

Gateway integrations are successfully retrieved.

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 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: optional (string)

    The KaaIoT platform gateway integration description.

  • endpointMetadata: optional (object)

    Endpoint metadata consists of multiple key-value pairs (called fields) where keys are strings, and the values are of any JSON type.
  • endpointRelations: optional (array of 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: optional (string)

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

    • to: optional (string)

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

  • ttnGatewayInfo: optional (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: optional (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: optional (boolean - default: false)

      The status of this gateway may be publicly displayed.

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

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

Gateway integration is successfully updated.

Body

Media type: application/json

Type: object

Properties

• 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: optional (string)

  The KaaIoT platform gateway integration description.

• endpointMetadata: optional (object)

  Endpoint metadata consists of multiple key-value pairs (called fields) where keys are strings, and the values are of any JSON type.
• endpointRelations: optional (array of 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: optional (string)

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

  • to: optional (string)

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

• ttnGatewayInfo: optional (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: optional (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: optional (boolean - default: false)

    The status of this gateway may be publicly displayed.

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

Properties

• 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

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

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

TTN application is successfully retrieved.

Body

Media type: application/json

Type: object

Properties

• 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: optional (string)

  The Things Network application description.

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

Properties

• message: required(string)

  Detailed error description.

HTTP status code 200

TTN devices are successfully retrieved.

Body

Media type: application/json

Type: array of TtnDeviceResponse

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

Properties

• 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

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

TTN devices are successfully retrieved.

Body

Media type: application/json

Type: array of TtnDeviceResponse

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"
    }
  }
]

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

• 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

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

TTN gateways are successfully retrieved.

Body

Media type: application/json

Type: array of TtnGatewaysResponse

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

Properties

• 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

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

Credencials are successfully verified.

HTTP status code 400

Invalid request.

Body

Media type: application/json

Type: object

Properties

• message: required(string)

  Detailed error description.