Destinations
Create a destination
Destinations
Create a destination
Create a new destination
POST
/
v2
/
destinations
curl --request POST \
--url https://api.portable.io/v2/destinations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"displayName": "<string>",
"destinationSpec": "<string>",
"properties": {}
}'
{
"data": {
"id": 123,
"displayName": "<string>",
"destinationSpec": {
"name": "<string>",
"displayName": "<string>",
"website": "<string>",
"tagLine": "<string>",
"lifecycle": "ALPHA",
"instructions": "<string>",
"propertyDefinitions": [
{
"name": "<string>",
"displayName": "<string>",
"type": "STRING",
"required": true,
"description": "<string>"
}
]
},
"properties": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
Destination to create
The body is of type object
.
Response
201
application/json
Created
The response is of type object
.
curl --request POST \
--url https://api.portable.io/v2/destinations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"displayName": "<string>",
"destinationSpec": "<string>",
"properties": {}
}'
{
"data": {
"id": 123,
"displayName": "<string>",
"destinationSpec": {
"name": "<string>",
"displayName": "<string>",
"website": "<string>",
"tagLine": "<string>",
"lifecycle": "ALPHA",
"instructions": "<string>",
"propertyDefinitions": [
{
"name": "<string>",
"displayName": "<string>",
"type": "STRING",
"required": true,
"description": "<string>"
}
]
},
"properties": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}