Create Deployment

curl --request POST \
  --url https://api.example.com/deployments/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "paused": false,
  "schedules": [
    {
      "schedule": {
        "interval": 123,
        "anchor_date": "2023-11-07T05:31:56Z",
        "timezone": "America/New_York"
      },
      "active": true,
      "max_scheduled_runs": 1,
      "parameters": {},
      "slug": "<string>",
      "replaces": "<string>"
    }
  ],
  "concurrency_limit": 1,
  "concurrency_options": {
    "grace_period_seconds": 43230
  },
  "global_concurrency_limit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "enforce_parameter_schema": true,
  "parameter_openapi_schema": {},
  "parameters": {},
  "tags": [
    "<string>"
  ],
  "labels": {
    "key": "value1",
    "key2": 42
  },
  "pull_steps": [
    {}
  ],
  "work_queue_name": "<string>",
  "work_pool_name": "my-work-pool",
  "storage_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "infrastructure_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "path": "<string>",
  "version": "<string>",
  "entrypoint": "<string>",
  "job_variables": {},
  "version_info": {
    "type": "<string>",
    "version": "<string>"
  }
}
'

import requests

url = "https://api.example.com/deployments/"

payload = {
    "name": "<string>",
    "flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "paused": False,
    "schedules": [
        {
            "schedule": {
                "interval": 123,
                "anchor_date": "2023-11-07T05:31:56Z",
                "timezone": "America/New_York"
            },
            "active": True,
            "max_scheduled_runs": 1,
            "parameters": {},
            "slug": "<string>",
            "replaces": "<string>"
        }
    ],
    "concurrency_limit": 1,
    "concurrency_options": { "grace_period_seconds": 43230 },
    "global_concurrency_limit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "enforce_parameter_schema": True,
    "parameter_openapi_schema": {},
    "parameters": {},
    "tags": ["<string>"],
    "labels": {
        "key": "value1",
        "key2": 42
    },
    "pull_steps": [{}],
    "work_queue_name": "<string>",
    "work_pool_name": "my-work-pool",
    "storage_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "infrastructure_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "description": "<string>",
    "path": "<string>",
    "version": "<string>",
    "entrypoint": "<string>",
    "job_variables": {},
    "version_info": {
        "type": "<string>",
        "version": "<string>"
    }
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    flow_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    paused: false,
    schedules: [
      {
        schedule: {
          interval: 123,
          anchor_date: '2023-11-07T05:31:56Z',
          timezone: 'America/New_York'
        },
        active: true,
        max_scheduled_runs: 1,
        parameters: {},
        slug: '<string>',
        replaces: '<string>'
      }
    ],
    concurrency_limit: 1,
    concurrency_options: {grace_period_seconds: 43230},
    global_concurrency_limit_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    enforce_parameter_schema: true,
    parameter_openapi_schema: {},
    parameters: {},
    tags: ['<string>'],
    labels: {key: 'value1', key2: 42},
    pull_steps: [{}],
    work_queue_name: '<string>',
    work_pool_name: 'my-work-pool',
    storage_document_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    infrastructure_document_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    description: '<string>',
    path: '<string>',
    version: '<string>',
    entrypoint: '<string>',
    job_variables: {},
    version_info: {type: '<string>', version: '<string>'}
  })
};

fetch('https://api.example.com/deployments/', 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://api.example.com/deployments/",
  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>',
    'flow_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'paused' => false,
    'schedules' => [
        [
                'schedule' => [
                                'interval' => 123,
                                'anchor_date' => '2023-11-07T05:31:56Z',
                                'timezone' => 'America/New_York'
                ],
                'active' => true,
                'max_scheduled_runs' => 1,
                'parameters' => [
                                
                ],
                'slug' => '<string>',
                'replaces' => '<string>'
        ]
    ],
    'concurrency_limit' => 1,
    'concurrency_options' => [
        'grace_period_seconds' => 43230
    ],
    'global_concurrency_limit_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'enforce_parameter_schema' => true,
    'parameter_openapi_schema' => [
        
    ],
    'parameters' => [
        
    ],
    'tags' => [
        '<string>'
    ],
    'labels' => [
        'key' => 'value1',
        'key2' => 42
    ],
    'pull_steps' => [
        [
                
        ]
    ],
    'work_queue_name' => '<string>',
    'work_pool_name' => 'my-work-pool',
    'storage_document_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'infrastructure_document_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'description' => '<string>',
    'path' => '<string>',
    'version' => '<string>',
    'entrypoint' => '<string>',
    'job_variables' => [
        
    ],
    'version_info' => [
        'type' => '<string>',
        'version' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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://api.example.com/deployments/"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"flow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"paused\": false,\n  \"schedules\": [\n    {\n      \"schedule\": {\n        \"interval\": 123,\n        \"anchor_date\": \"2023-11-07T05:31:56Z\",\n        \"timezone\": \"America/New_York\"\n      },\n      \"active\": true,\n      \"max_scheduled_runs\": 1,\n      \"parameters\": {},\n      \"slug\": \"<string>\",\n      \"replaces\": \"<string>\"\n    }\n  ],\n  \"concurrency_limit\": 1,\n  \"concurrency_options\": {\n    \"grace_period_seconds\": 43230\n  },\n  \"global_concurrency_limit_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"enforce_parameter_schema\": true,\n  \"parameter_openapi_schema\": {},\n  \"parameters\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"labels\": {\n    \"key\": \"value1\",\n    \"key2\": 42\n  },\n  \"pull_steps\": [\n    {}\n  ],\n  \"work_queue_name\": \"<string>\",\n  \"work_pool_name\": \"my-work-pool\",\n  \"storage_document_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"infrastructure_document_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"description\": \"<string>\",\n  \"path\": \"<string>\",\n  \"version\": \"<string>\",\n  \"entrypoint\": \"<string>\",\n  \"job_variables\": {},\n  \"version_info\": {\n    \"type\": \"<string>\",\n    \"version\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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://api.example.com/deployments/")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"flow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"paused\": false,\n  \"schedules\": [\n    {\n      \"schedule\": {\n        \"interval\": 123,\n        \"anchor_date\": \"2023-11-07T05:31:56Z\",\n        \"timezone\": \"America/New_York\"\n      },\n      \"active\": true,\n      \"max_scheduled_runs\": 1,\n      \"parameters\": {},\n      \"slug\": \"<string>\",\n      \"replaces\": \"<string>\"\n    }\n  ],\n  \"concurrency_limit\": 1,\n  \"concurrency_options\": {\n    \"grace_period_seconds\": 43230\n  },\n  \"global_concurrency_limit_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"enforce_parameter_schema\": true,\n  \"parameter_openapi_schema\": {},\n  \"parameters\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"labels\": {\n    \"key\": \"value1\",\n    \"key2\": 42\n  },\n  \"pull_steps\": [\n    {}\n  ],\n  \"work_queue_name\": \"<string>\",\n  \"work_pool_name\": \"my-work-pool\",\n  \"storage_document_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"infrastructure_document_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"description\": \"<string>\",\n  \"path\": \"<string>\",\n  \"version\": \"<string>\",\n  \"entrypoint\": \"<string>\",\n  \"job_variables\": {},\n  \"version_info\": {\n    \"type\": \"<string>\",\n    \"version\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/deployments/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"flow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"paused\": false,\n  \"schedules\": [\n    {\n      \"schedule\": {\n        \"interval\": 123,\n        \"anchor_date\": \"2023-11-07T05:31:56Z\",\n        \"timezone\": \"America/New_York\"\n      },\n      \"active\": true,\n      \"max_scheduled_runs\": 1,\n      \"parameters\": {},\n      \"slug\": \"<string>\",\n      \"replaces\": \"<string>\"\n    }\n  ],\n  \"concurrency_limit\": 1,\n  \"concurrency_options\": {\n    \"grace_period_seconds\": 43230\n  },\n  \"global_concurrency_limit_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"enforce_parameter_schema\": true,\n  \"parameter_openapi_schema\": {},\n  \"parameters\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"labels\": {\n    \"key\": \"value1\",\n    \"key2\": 42\n  },\n  \"pull_steps\": [\n    {}\n  ],\n  \"work_queue_name\": \"<string>\",\n  \"work_pool_name\": \"my-work-pool\",\n  \"storage_document_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"infrastructure_document_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"description\": \"<string>\",\n  \"path\": \"<string>\",\n  \"version\": \"<string>\",\n  \"entrypoint\": \"<string>\",\n  \"job_variables\": {},\n  \"version_info\": {\n    \"type\": \"<string>\",\n    \"version\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "version": "<string>",
  "description": "<string>",
  "paused": false,
  "schedules": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z",
      "schedule": {
        "interval": 123,
        "anchor_date": "2023-11-07T05:31:56Z",
        "timezone": "America/New_York"
      },
      "deployment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "active": true,
      "max_scheduled_runs": 1,
      "parameters": {},
      "slug": "<string>"
    }
  ],
  "concurrency_limit": 123,
  "global_concurrency_limit": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "limit": 123,
    "active_slots": 123,
    "active": true,
    "slot_decay_per_second": 2
  },
  "concurrency_options": {
    "grace_period_seconds": 43230
  },
  "job_variables": {},
  "parameters": {},
  "tags": [
    "<string>"
  ],
  "labels": {},
  "work_queue_name": "<string>",
  "work_queue_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "last_polled": "2023-11-07T05:31:56Z",
  "parameter_openapi_schema": {},
  "path": "<string>",
  "pull_steps": [
    {}
  ],
  "entrypoint": "<string>",
  "storage_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "infrastructure_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_by": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "display_value": "<string>"
  },
  "updated_by": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "display_value": "<string>"
  },
  "work_pool_name": "<string>",
  "status": "NOT_READY",
  "enforce_parameter_schema": true
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

POST

deployments

Create Deployment

curl --request POST \
  --url https://api.example.com/deployments/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "paused": false,
  "schedules": [
    {
      "schedule": {
        "interval": 123,
        "anchor_date": "2023-11-07T05:31:56Z",
        "timezone": "America/New_York"
      },
      "active": true,
      "max_scheduled_runs": 1,
      "parameters": {},
      "slug": "<string>",
      "replaces": "<string>"
    }
  ],
  "concurrency_limit": 1,
  "concurrency_options": {
    "grace_period_seconds": 43230
  },
  "global_concurrency_limit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "enforce_parameter_schema": true,
  "parameter_openapi_schema": {},
  "parameters": {},
  "tags": [
    "<string>"
  ],
  "labels": {
    "key": "value1",
    "key2": 42
  },
  "pull_steps": [
    {}
  ],
  "work_queue_name": "<string>",
  "work_pool_name": "my-work-pool",
  "storage_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "infrastructure_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "description": "<string>",
  "path": "<string>",
  "version": "<string>",
  "entrypoint": "<string>",
  "job_variables": {},
  "version_info": {
    "type": "<string>",
    "version": "<string>"
  }
}
'

import requests

url = "https://api.example.com/deployments/"

payload = {
    "name": "<string>",
    "flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "paused": False,
    "schedules": [
        {
            "schedule": {
                "interval": 123,
                "anchor_date": "2023-11-07T05:31:56Z",
                "timezone": "America/New_York"
            },
            "active": True,
            "max_scheduled_runs": 1,
            "parameters": {},
            "slug": "<string>",
            "replaces": "<string>"
        }
    ],
    "concurrency_limit": 1,
    "concurrency_options": { "grace_period_seconds": 43230 },
    "global_concurrency_limit_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "enforce_parameter_schema": True,
    "parameter_openapi_schema": {},
    "parameters": {},
    "tags": ["<string>"],
    "labels": {
        "key": "value1",
        "key2": 42
    },
    "pull_steps": [{}],
    "work_queue_name": "<string>",
    "work_pool_name": "my-work-pool",
    "storage_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "infrastructure_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "description": "<string>",
    "path": "<string>",
    "version": "<string>",
    "entrypoint": "<string>",
    "job_variables": {},
    "version_info": {
        "type": "<string>",
        "version": "<string>"
    }
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    flow_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    paused: false,
    schedules: [
      {
        schedule: {
          interval: 123,
          anchor_date: '2023-11-07T05:31:56Z',
          timezone: 'America/New_York'
        },
        active: true,
        max_scheduled_runs: 1,
        parameters: {},
        slug: '<string>',
        replaces: '<string>'
      }
    ],
    concurrency_limit: 1,
    concurrency_options: {grace_period_seconds: 43230},
    global_concurrency_limit_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    enforce_parameter_schema: true,
    parameter_openapi_schema: {},
    parameters: {},
    tags: ['<string>'],
    labels: {key: 'value1', key2: 42},
    pull_steps: [{}],
    work_queue_name: '<string>',
    work_pool_name: 'my-work-pool',
    storage_document_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    infrastructure_document_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    description: '<string>',
    path: '<string>',
    version: '<string>',
    entrypoint: '<string>',
    job_variables: {},
    version_info: {type: '<string>', version: '<string>'}
  })
};

fetch('https://api.example.com/deployments/', 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://api.example.com/deployments/",
  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>',
    'flow_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'paused' => false,
    'schedules' => [
        [
                'schedule' => [
                                'interval' => 123,
                                'anchor_date' => '2023-11-07T05:31:56Z',
                                'timezone' => 'America/New_York'
                ],
                'active' => true,
                'max_scheduled_runs' => 1,
                'parameters' => [
                                
                ],
                'slug' => '<string>',
                'replaces' => '<string>'
        ]
    ],
    'concurrency_limit' => 1,
    'concurrency_options' => [
        'grace_period_seconds' => 43230
    ],
    'global_concurrency_limit_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'enforce_parameter_schema' => true,
    'parameter_openapi_schema' => [
        
    ],
    'parameters' => [
        
    ],
    'tags' => [
        '<string>'
    ],
    'labels' => [
        'key' => 'value1',
        'key2' => 42
    ],
    'pull_steps' => [
        [
                
        ]
    ],
    'work_queue_name' => '<string>',
    'work_pool_name' => 'my-work-pool',
    'storage_document_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'infrastructure_document_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'description' => '<string>',
    'path' => '<string>',
    'version' => '<string>',
    'entrypoint' => '<string>',
    'job_variables' => [
        
    ],
    'version_info' => [
        'type' => '<string>',
        'version' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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://api.example.com/deployments/"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"flow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"paused\": false,\n  \"schedules\": [\n    {\n      \"schedule\": {\n        \"interval\": 123,\n        \"anchor_date\": \"2023-11-07T05:31:56Z\",\n        \"timezone\": \"America/New_York\"\n      },\n      \"active\": true,\n      \"max_scheduled_runs\": 1,\n      \"parameters\": {},\n      \"slug\": \"<string>\",\n      \"replaces\": \"<string>\"\n    }\n  ],\n  \"concurrency_limit\": 1,\n  \"concurrency_options\": {\n    \"grace_period_seconds\": 43230\n  },\n  \"global_concurrency_limit_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"enforce_parameter_schema\": true,\n  \"parameter_openapi_schema\": {},\n  \"parameters\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"labels\": {\n    \"key\": \"value1\",\n    \"key2\": 42\n  },\n  \"pull_steps\": [\n    {}\n  ],\n  \"work_queue_name\": \"<string>\",\n  \"work_pool_name\": \"my-work-pool\",\n  \"storage_document_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"infrastructure_document_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"description\": \"<string>\",\n  \"path\": \"<string>\",\n  \"version\": \"<string>\",\n  \"entrypoint\": \"<string>\",\n  \"job_variables\": {},\n  \"version_info\": {\n    \"type\": \"<string>\",\n    \"version\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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://api.example.com/deployments/")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"flow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"paused\": false,\n  \"schedules\": [\n    {\n      \"schedule\": {\n        \"interval\": 123,\n        \"anchor_date\": \"2023-11-07T05:31:56Z\",\n        \"timezone\": \"America/New_York\"\n      },\n      \"active\": true,\n      \"max_scheduled_runs\": 1,\n      \"parameters\": {},\n      \"slug\": \"<string>\",\n      \"replaces\": \"<string>\"\n    }\n  ],\n  \"concurrency_limit\": 1,\n  \"concurrency_options\": {\n    \"grace_period_seconds\": 43230\n  },\n  \"global_concurrency_limit_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"enforce_parameter_schema\": true,\n  \"parameter_openapi_schema\": {},\n  \"parameters\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"labels\": {\n    \"key\": \"value1\",\n    \"key2\": 42\n  },\n  \"pull_steps\": [\n    {}\n  ],\n  \"work_queue_name\": \"<string>\",\n  \"work_pool_name\": \"my-work-pool\",\n  \"storage_document_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"infrastructure_document_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"description\": \"<string>\",\n  \"path\": \"<string>\",\n  \"version\": \"<string>\",\n  \"entrypoint\": \"<string>\",\n  \"job_variables\": {},\n  \"version_info\": {\n    \"type\": \"<string>\",\n    \"version\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/deployments/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"flow_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"paused\": false,\n  \"schedules\": [\n    {\n      \"schedule\": {\n        \"interval\": 123,\n        \"anchor_date\": \"2023-11-07T05:31:56Z\",\n        \"timezone\": \"America/New_York\"\n      },\n      \"active\": true,\n      \"max_scheduled_runs\": 1,\n      \"parameters\": {},\n      \"slug\": \"<string>\",\n      \"replaces\": \"<string>\"\n    }\n  ],\n  \"concurrency_limit\": 1,\n  \"concurrency_options\": {\n    \"grace_period_seconds\": 43230\n  },\n  \"global_concurrency_limit_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"enforce_parameter_schema\": true,\n  \"parameter_openapi_schema\": {},\n  \"parameters\": {},\n  \"tags\": [\n    \"<string>\"\n  ],\n  \"labels\": {\n    \"key\": \"value1\",\n    \"key2\": 42\n  },\n  \"pull_steps\": [\n    {}\n  ],\n  \"work_queue_name\": \"<string>\",\n  \"work_pool_name\": \"my-work-pool\",\n  \"storage_document_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"infrastructure_document_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"description\": \"<string>\",\n  \"path\": \"<string>\",\n  \"version\": \"<string>\",\n  \"entrypoint\": \"<string>\",\n  \"job_variables\": {},\n  \"version_info\": {\n    \"type\": \"<string>\",\n    \"version\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "version": "<string>",
  "description": "<string>",
  "paused": false,
  "schedules": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z",
      "schedule": {
        "interval": 123,
        "anchor_date": "2023-11-07T05:31:56Z",
        "timezone": "America/New_York"
      },
      "deployment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "active": true,
      "max_scheduled_runs": 1,
      "parameters": {},
      "slug": "<string>"
    }
  ],
  "concurrency_limit": 123,
  "global_concurrency_limit": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created": "2023-11-07T05:31:56Z",
    "updated": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "limit": 123,
    "active_slots": 123,
    "active": true,
    "slot_decay_per_second": 2
  },
  "concurrency_options": {
    "grace_period_seconds": 43230
  },
  "job_variables": {},
  "parameters": {},
  "tags": [
    "<string>"
  ],
  "labels": {},
  "work_queue_name": "<string>",
  "work_queue_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "last_polled": "2023-11-07T05:31:56Z",
  "parameter_openapi_schema": {},
  "path": "<string>",
  "pull_steps": [
    {}
  ],
  "entrypoint": "<string>",
  "storage_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "infrastructure_document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_by": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "display_value": "<string>"
  },
  "updated_by": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "display_value": "<string>"
  },
  "work_pool_name": "<string>",
  "status": "NOT_READY",
  "enforce_parameter_schema": true
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Headers

x-prefect-api-version

string

Body

application/json

Data used by the Prefect REST API to create a deployment.

name

string

required

The name of the deployment.

Example:

"my-deployment"

flow_id

string<uuid>

required

The ID of the flow associated with the deployment.

paused

boolean

default:false

Whether or not the deployment is paused.

schedules

DeploymentScheduleCreate · object[]

A list of schedules for the deployment.

Show child attributes

concurrency_limit

integer | null

The deployment's concurrency limit.

Required range: x > 0

concurrency_options

ConcurrencyOptions · object | null

The deployment's concurrency options.

Show child attributes

global_concurrency_limit_id

string<uuid> | null

The ID of the global concurrency limit to apply to the deployment.

enforce_parameter_schema

boolean

default:true

Whether or not the deployment should enforce the parameter schema.

parameter_openapi_schema

Parameter Openapi Schema · object

The parameter schema of the flow, including defaults.

parameters

Parameters · object

Parameters for flow runs scheduled by the deployment.

Response

Successful Response

string<uuid>

required

created

string<date-time> | null

required

updated

string<date-time> | null

required

name

string

required

The name of the deployment.

flow_id

string<uuid>

required

The flow id associated with the deployment.

version

string | null

An optional version for the deployment.

description

string | null

A description for the deployment.

paused

boolean

default:false

Whether or not the deployment is paused.

schedules

DeploymentSchedule · object[]

A list of schedules for the deployment.

Show child attributes

concurrency_limit

integer | null

deprecated

DEPRECATED: Prefer global_concurrency_limit. Will always be None for backwards compatibility. Will be removed after December 2024.

global_concurrency_limit

GlobalConcurrencyLimitResponse · object | null

The global concurrency limit object for enforcing the maximum number of flow runs that can be active at once.

Show child attributes

concurrency_options

ConcurrencyOptions · object | null

The concurrency options for the deployment.

Show child attributes

job_variables

Job Variables · object

Overrides to apply to the base infrastructure block at runtime.

parameters

Parameters · object

Parameters for flow runs scheduled by the deployment.