Skip to main content
POST
/
integration
cURL
curl --request POST \
  --url http://sandbox.batuenergy.com/api/v1/integration \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "protocol": "HTTP",
  "type": "pull",
  "specs": [
    {
      "granularity": "5m",
      "range": "1mo",
      "schedule": "* * * * *",
      "shift": true
    }
  ],
  "metadata": "<string>"
}
'
{
  "status": "success",
  "data": {
    "execution": "exe_<uuid>",
    "integration": {
      "id": "<uuid>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "protocol": "HTTP",
      "type": "pull",
      "specs": [
        {
          "granularity": "5m",
          "range": "1mo",
          "schedule": "* * * * *",
          "shift": true
        }
      ],
      "metadata": "<string>"
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string
required

The name of the integration

protocol
enum<string>
required

The protocol of the integration

Available options:
HTTP,
MQTT,
Websocket,
Modbus,
Backnet,
DBQuery
type
enum<string>
required

The type of the integration

Available options:
pull,
push
specs
object[]
required

The specifications supported by the integration

metadata
string | null

The metadata associated with the integration

Response

Integration response

status
string
required

Indicates the request was successful

Example:

"success"

data
object
required

The data associated with the response