Skip to main content
POST
/
decks
Create a Deck
curl --request POST \
  --url https://sandbox.deck.co/api/v1/decks \
  --header 'Content-Type: application/json' \
  --header 'x-deck-client-id: <api-key>' \
  --header 'x-deck-secret: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'
{
  "deck_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "sources": [
    {
      "source_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "url": "<string>",
      "target_url": "<string>"
    }
  ],
  "jobs": [
    {
      "job_code": "<string>",
      "name": "<string>",
      "sort_order": 123,
      "job_definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "created_at": 123,
  "updated_at": 123,
  "description": "<string>"
}

Authorizations

x-deck-client-id
string
header
required

Enter your client id

x-deck-secret
string
header
required

Enter your secret

Body

name
string
required

The name for the deck.

description
string | null

The description for the deck.

Response

OK

deck_id
string<uuid>
required

The identifier for the deck.

name
string
required

The name of the deck.

sources
object[]
required

The sources associated with this deck.

jobs
object[]
required

The jobs associated with this deck.

created_at
integer<int64>
required

The time the deck was created.

updated_at
integer<int64>
required

The time the deck was last updated.

description
string | null

The description of the deck.