Skip to main content
POST
/
v2
/
destinations
Create a destination
curl --request POST \
  --url https://api.portable.io/v2/destinations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "destinationSpec": "<string>",
  "displayName": "<string>",
  "properties": {}
}
'
{
  "data": {
    "id": 123,
    "destinationSpec": {
      "name": "<string>",
      "displayName": "<string>",
      "website": "<string>",
      "tagLine": "<string>",
      "lifecycle": "ALPHA",
      "instructions": "<string>",
      "propertyDefinitions": [
        {
          "name": "<string>",
          "type": "STRING",
          "required": true,
          "displayName": "<string>",
          "description": "<string>"
        }
      ]
    },
    "displayName": "<string>",
    "properties": {},
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Destination to create

​
destinationSpec
string
required

The name of the destination spec to create a destination for

​
displayName
string

A human-readable name for the destination

​
properties
object

Response

Created

​
data
object
required