IoT Integrator

Get Customer Integration

Get Customer Integration details

get/v1/integrate/clouds/{integrationId}

Request

Base URL
https://api.1nce.com/management-api
Auth
HTTP bearer

Path parameters

integrationIdstring required

unique integration ID

Response

Customer Integration Details.

idstring required

Unique ID of the Integration

lastSuccessfulMessageDeliverystring date-time

Timestamp of the first message successfully delivered to integration, in ISO 8601 format

namestring required

name

state'ROLLOUT_STARTED' | 'ROLLOUT_DONE' | 'ROLLOUT_FAILED' | 'INTEGRATION_FAILED' | 'INTEGRATION_ACTIVE' required

Current state of the Integration

type'AWS' | 'WEBHOOK' required

Type of the Integration

awsAccountIdstring

AWS Account Id where the stack was deployed, only showed when AWS Integration

regionstring

AWS Region where the stack was deployed, only showed when AWS Integration

errorstring

Last error either during the creation of the Integration or during some attempt to integrate

jwtstring

JWT token with details for integration stack creation

createdTimestring date-time required

Created timestamp of Integration

updatedTimestring date-time required

Updated timestamp of Integration

urlstring uri

URL of the Webhook Integration

headersobject

Headers of the Webhook Integration

jsonPayloadEnabledboolean required

Flag if the payloads of this integration should be bridged in JSON format.

Example response

{
  "id": "2BLURnaUZSlbKp6vN1V5dYiJvC4",
  "lastSuccessfulMessageDelivery": "2022-03-07T08:51:29.015Z",
  "name": "a-sample-integration-name",
  "eventTypes": [
    {
      "type": "TELEMETRY_DATA",
      "version": "1.0.0"
    }
  ],
  "awsAccountId": "123456789012",
  "region": "eu-central-1",
  "error": "some error has just happened",
  "jwt": "<jwt_token>",
  "createdTime": "2022-03-07T08:51:29.015Z",
  "updatedTime": "2022-03-07T08:51:29.015Z",
  "url": "https://example.com",
  "jsonPayloadEnabled": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.