Creates an Integration

post

https://api.edgeiq.io/api/v1/platform/integrations

Integrations are used to classify devices, which represent specific, addressable instances of that class of device.

Body Params

name

string

required

The unique name of the integration.

type

string

required

The integration type.

long_description

string

Detailed description for integration

region

string

(AWS) The region of the AWS IoT integration

role_arn

string

(AWS) The ARN of the IAM role for the AWS IoT integration

external_id

string

(AWS) The external id for the AWS integration

iot_hub_hostname

string

(Azure IoT) The hostname of the IoT Hub in Azure IoT

access_policy_name

string

(Azure IoT) The name of the access policy in Azure IoT

shared_access_key

string

(Azure IoT) The shared access key from Azure IoT

org_id

string

(Bluemix IoT) Your Bluemix account's organization id

api_key

string

(Bluemix IoT) Your Bluemix account's API key

auth_token

string

(Bluemix IoT) Your Bluemix account's Auth token

token

string

(OpenAI/Anthropic/Generic Token) The authentication token for the API

base_url

string

(OpenAI) The URL for the OpenAI service. If not provided, defaults to https://api.openai.com/v1

device_ids

array of strings

List of associated Device IDs. The 'device_ids' field cannot be edited. Please assign the Integration to the Device on create of Device.

device_ids

Responses

200

Successful operation

401

You are not authorized

404

The item you were looking for does not exist

500

An unexpected error was encountered.

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here!