Skip to main content
POST
/
connections
Create a Connection
curl --request POST \
  --url https://sandbox.deck.co/api/v1/connections \
  --header 'Content-Type: application/json' \
  --header 'x-deck-client-id: <api-key>' \
  --header 'x-deck-secret: <api-key>' \
  --data '
{
  "source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "auth_method": "<string>",
  "auth_credentials": {
    "username": "<string>",
    "password": "<string>"
  },
  "deck_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "auth_method": "<string>",
  "created_at": 123,
  "updated_at": 123,
  "access_token": "<string>"
}

Authorizations

​
x-deck-client-id
string
header
required

Enter your client id

​
x-deck-secret
string
header
required

Enter your secret

Body

application/json

Connection creation request

​
source_id
string<uuid>
required
​
auth_method
string
required
Minimum string length: 1
​
auth_credentials
object
​
deck_id
string<uuid> | null

Response

Accepted

​
connection_id
string<uuid>
required
​
status
string
required
​
source_id
string<uuid>
required
​
auth_method
string
required
​
created_at
integer<int64>
required
​
updated_at
integer<int64>
required
​
access_token
string | null