Destination Specs
Get destination spec
Destination Specs
Get destination spec
Get a destination spec by name
GET
/
v2
/
destinationspecs
/
{name}
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
name
string
*
name
Required
string
Name
curl --request GET \
--url https://api.portable.io/v2/destinationspecs/{name} \
--header 'Authorization: Bearer <token>'
{
"data": {
"name": "<string>",
"displayName": "<string>",
"website": "<string>",
"tagLine": "<string>",
"lifecycle": "ALPHA",
"instructions": "<string>",
"propertyDefinitions": [
{
"name": "<string>",
"displayName": "<string>",
"type": "STRING",
"required": true,
"description": "<string>"
}
]
}
}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
name
string
requiredName
Response
200 - application/json
data
object
requireddata.name
string
The name of the destination spec
data.displayName
string
A human-readable name for the destination spec
data.website
string
The website of the destination spec
data.tagLine
string
A one line description of the destination spec
data.lifecycle
enum<string>
Available options:
ALPHA
, BETA
, STABLE
, DEPRECATED
data.instructions
string
data.propertyDefinitions
object[]
data.propertyDefinitions.name
string
requiredA machine-readable name for the property
data.propertyDefinitions.displayName
string
A human-readable name for the property
data.propertyDefinitions.type
enum<string>
requiredThe type of the property
Available options:
STRING
, PASSWORD
, TEXT
, NUMBER
, BOOLEAN
, DATE
, DATETIME
, TIME
data.propertyDefinitions.required
boolean
requiredWhether the property's value is required
data.propertyDefinitions.description
string
A human-readable description of the property
curl --request GET \
--url https://api.portable.io/v2/destinationspecs/{name} \
--header 'Authorization: Bearer <token>'
{
"data": {
"name": "<string>",
"displayName": "<string>",
"website": "<string>",
"tagLine": "<string>",
"lifecycle": "ALPHA",
"instructions": "<string>",
"propertyDefinitions": [
{
"name": "<string>",
"displayName": "<string>",
"type": "STRING",
"required": true,
"description": "<string>"
}
]
}
}