Skip to content

Create a destination

POST
/v1/destinations

Adds a registry entry. The entry is created pending and only becomes active once schema, credentials and a live connectivity test pass.

Authorizations

apiKey

Scoped API key. Scopes are readwriteadmin. A call needing more scope than the key holds returns 403 insufficient_scope.

Type
HTTP (bearer)

Request Body

application/json
JSON
{
  
"name": "acme-orders",
  
"type": "string",
  
"url": "https://api.acme.in/hooks/orders",
  
"config": {
  
}
}

Responses

Created — pending validation.

application/json
JSON
{
  
"id": "dst_01JX9",
  
"name": "acme-orders",
  
"type": "string",
  
"validation": "pending",
  
"version": 1
}

Playground

Authorization
Body

Samples

Powered by VitePress OpenAPI

Apache-2.0 licensed · a Finnoto product