Create a Deck
curl --request POST \
--url https://live.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>"
}
'import requests
url = "https://live.deck.co/api/v1/decks"
payload = {
"name": "<string>",
"description": "<string>"
}
headers = {
"x-deck-client-id": "<api-key>",
"x-deck-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-deck-client-id': '<api-key>',
'x-deck-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({name: '<string>', description: '<string>'})
};
fetch('https://live.deck.co/api/v1/decks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://live.deck.co/api/v1/decks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-deck-client-id: <api-key>",
"x-deck-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://live.deck.co/api/v1/decks"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-deck-client-id", "<api-key>")
req.Header.Add("x-deck-secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://live.deck.co/api/v1/decks")
.header("x-deck-client-id", "<api-key>")
.header("x-deck-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://live.deck.co/api/v1/decks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-deck-client-id"] = '<api-key>'
request["x-deck-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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>"
}{
"error_message": "<string>",
"display_message": "<string>"
}Deck
Create a Deck
A deck holds and organizes your jobs and sources.
POST
/
decks
Create a Deck
curl --request POST \
--url https://live.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>"
}
'import requests
url = "https://live.deck.co/api/v1/decks"
payload = {
"name": "<string>",
"description": "<string>"
}
headers = {
"x-deck-client-id": "<api-key>",
"x-deck-secret": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-deck-client-id': '<api-key>',
'x-deck-secret': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({name: '<string>', description: '<string>'})
};
fetch('https://live.deck.co/api/v1/decks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://live.deck.co/api/v1/decks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-deck-client-id: <api-key>",
"x-deck-secret: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://live.deck.co/api/v1/decks"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-deck-client-id", "<api-key>")
req.Header.Add("x-deck-secret", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://live.deck.co/api/v1/decks")
.header("x-deck-client-id", "<api-key>")
.header("x-deck-secret", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://live.deck.co/api/v1/decks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-deck-client-id"] = '<api-key>'
request["x-deck-secret"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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>"
}{
"error_message": "<string>",
"display_message": "<string>"
}Authorizations
Enter your client id
Enter your secret
Body
application/jsontext/jsonapplication/*+json
Response
OK
The identifier for the deck.
The name of the deck.
The sources associated with this deck.
Show child attributes
Show child attributes
The jobs associated with this deck.
Show child attributes
Show child attributes
The time the deck was created.
The time the deck was last updated.
The description of the deck.
Was this page helpful?
⌘I