Skip to main content
POST
/
api
/
admin
/
integrations
Create integration
curl --request POST \
  --url https://{instance}.{env}.on-hellgate.cloud/api/admin/integrations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "base_url": "http://link:4000",
  "name": "Link Production",
  "slug": "link-prod",
  "type": "link",
  "description": "<string>",
  "enabled": true,
  "timeout_ms": 5000
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "base_url": "http://link:4000",
  "description": "<string>",
  "enabled": true,
  "inserted_at": "2023-11-07T05:31:56Z",
  "name": "Link Production",
  "slug": "link-prod",
  "timeout_ms": 5000,
  "type": "link",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

HS256-signed JWT bearer token, obtained via the OAuth2 client-credentials grant (see Authentication).

Body

application/json

Integration attributes

​
base_url
string
required
Example:

"http://link:4000"

​
name
string
required
Example:

"Link Production"

​
slug
string
required

Stable, lowercase slug used to reference the integration in rules

Example:

"link-prod"

​
type
enum<string>
required

link — points at a Link instance (rules supply a /<backend_id> suffix).

Available options:
link
​
description
string | null
​
enabled
boolean
default:true
​
timeout_ms
integer
Example:

5000

Response

Created integration

​
id
string<uuid>
​
base_url
string
Example:

"http://link:4000"

​
description
string | null
​
enabled
boolean
​
inserted_at
string<date-time>
​
name
string
Example:

"Link Production"

​
slug
string
Example:

"link-prod"

​
timeout_ms
integer
Example:

5000

​
type
enum<string>
Available options:
link
​
updated_at
string<date-time>