Create a destination
Create a new destination
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
A human-readable name for the destination
The name of the destination spec to create a destination for
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
A human-readable name for the destination
The name of the destination spec to create a destination for
Response
A human-readable name for the destination
The name of the destination spec
A human-readable name for the destination spec
The website of the destination spec
A one line description of the destination spec
ALPHA
, BETA
, STABLE
, DEPRECATED
A machine-readable name for the property
A human-readable name for the property
The type of the property
STRING
, PASSWORD
, TEXT
, NUMBER
, BOOLEAN
, DATE
, DATETIME
, TIME
Whether the property's value is required
A human-readable description of the property
The properties of the destination. This is a map of property names to their values. The names are defined in the propertyDefinitions
field of the destination spec.
The timestamp marking when the destination was created
The timestamp marking when the destination was last updated
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"
}
}