Work Queue Check For Deployment
curl --request GET \
--url https://api.example.com/deployments/{id}/work_queue_checkimport requests
url = "https://api.example.com/deployments/{id}/work_queue_check"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/deployments/{id}/work_queue_check', 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/{id}/work_queue_check",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/deployments/{id}/work_queue_check"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/deployments/{id}/work_queue_check")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/deployments/{id}/work_queue_check")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
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>",
"description": "",
"is_paused": false,
"concurrency_limit": 1,
"priority": 1,
"work_pool_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filter": {
"tags": [
"<string>"
],
"deployment_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"last_polled": "2023-11-07T05:31:56Z"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Deployments
Work Queue Check For Deployment
deprecated
Get list of work-queues that are able to pick up the specified deployment.
This endpoint is intended to be used by the UI to provide users warnings about deployments that are unable to be executed because there are no work queues that will pick up their runs, based on existing filter criteria. It may be deprecated in the future because there is not a strict relationship between work queues and deployments.
GET
/
deployments
/
{id}
/
work_queue_check
Work Queue Check For Deployment
curl --request GET \
--url https://api.example.com/deployments/{id}/work_queue_checkimport requests
url = "https://api.example.com/deployments/{id}/work_queue_check"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/deployments/{id}/work_queue_check', 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/{id}/work_queue_check",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/deployments/{id}/work_queue_check"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/deployments/{id}/work_queue_check")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/deployments/{id}/work_queue_check")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
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>",
"description": "",
"is_paused": false,
"concurrency_limit": 1,
"priority": 1,
"work_pool_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"filter": {
"tags": [
"<string>"
],
"deployment_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
]
},
"last_polled": "2023-11-07T05:31:56Z"
}
]{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Headers
Path Parameters
The deployment id
Response
Successful Response
The name of the work queue.
Pattern:
^[^/%&><]+$An optional description for the work queue.
Whether or not the work queue is paused.
An optional concurrency limit for the work queue.
Required range:
x >= 0The queue's priority. Lower values are higher priority (1 is the highest).
The work pool with which the queue is associated.
DEPRECATED: Filter criteria for the work queue.
Show child attributes
Show child attributes
The last time an agent polled this queue for work.
Was this page helpful?