Jobs
Set step blacklist
Set the machines kept off one step
PUT
/
jobs
/
{id}
/
steps
/
{step_id}
/
blacklist
Set step blacklist
curl --request PUT \
--url http://localhost:44442/api/v1/jobs/{id}/steps/{step_id}/blacklist \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"blacklisted_nodes": [
"68b1f0c2a4d3e5f6a7b8c9d0"
]
}
'import requests
url = "http://localhost:44442/api/v1/jobs/{id}/steps/{step_id}/blacklist"
payload = { "blacklisted_nodes": ["68b1f0c2a4d3e5f6a7b8c9d0"] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({blacklisted_nodes: ['68b1f0c2a4d3e5f6a7b8c9d0']})
};
fetch('http://localhost:44442/api/v1/jobs/{id}/steps/{step_id}/blacklist', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "44442",
CURLOPT_URL => "http://localhost:44442/api/v1/jobs/{id}/steps/{step_id}/blacklist",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'blacklisted_nodes' => [
'68b1f0c2a4d3e5f6a7b8c9d0'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "http://localhost:44442/api/v1/jobs/{id}/steps/{step_id}/blacklist"
payload := strings.NewReader("{\n \"blacklisted_nodes\": [\n \"68b1f0c2a4d3e5f6a7b8c9d0\"\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.put("http://localhost:44442/api/v1/jobs/{id}/steps/{step_id}/blacklist")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"blacklisted_nodes\": [\n \"68b1f0c2a4d3e5f6a7b8c9d0\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:44442/api/v1/jobs/{id}/steps/{step_id}/blacklist")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"blacklisted_nodes\": [\n \"68b1f0c2a4d3e5f6a7b8c9d0\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>"
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}Authorizations
An API key from Settings, API Keys. A caller on this machine needs none.
Path Parameters
Pattern:
^[a-fA-F0-9]{24}$Example:
"68b1f0c2a4d3e5f6a7b8c9d0"
Pattern:
^[a-fA-F0-9]{24}$Example:
"68b1f0c2a4d3e5f6a7b8c9d0"
Body
application/json
Every machine kept off this step; replaces the list, so an empty one clears it
Maximum array length:
1000Pattern:
^[a-fA-F0-9]{24}$Response
The step's blacklist
Was this page helpful?
⌘I
Set step blacklist
curl --request PUT \
--url http://localhost:44442/api/v1/jobs/{id}/steps/{step_id}/blacklist \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"blacklisted_nodes": [
"68b1f0c2a4d3e5f6a7b8c9d0"
]
}
'import requests
url = "http://localhost:44442/api/v1/jobs/{id}/steps/{step_id}/blacklist"
payload = { "blacklisted_nodes": ["68b1f0c2a4d3e5f6a7b8c9d0"] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({blacklisted_nodes: ['68b1f0c2a4d3e5f6a7b8c9d0']})
};
fetch('http://localhost:44442/api/v1/jobs/{id}/steps/{step_id}/blacklist', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "44442",
CURLOPT_URL => "http://localhost:44442/api/v1/jobs/{id}/steps/{step_id}/blacklist",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'blacklisted_nodes' => [
'68b1f0c2a4d3e5f6a7b8c9d0'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "http://localhost:44442/api/v1/jobs/{id}/steps/{step_id}/blacklist"
payload := strings.NewReader("{\n \"blacklisted_nodes\": [\n \"68b1f0c2a4d3e5f6a7b8c9d0\"\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.put("http://localhost:44442/api/v1/jobs/{id}/steps/{step_id}/blacklist")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"blacklisted_nodes\": [\n \"68b1f0c2a4d3e5f6a7b8c9d0\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:44442/api/v1/jobs/{id}/steps/{step_id}/blacklist")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"blacklisted_nodes\": [\n \"68b1f0c2a4d3e5f6a7b8c9d0\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>"
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}{
"error": "<string>",
"tag": "<string>",
"title": "<string>",
"detail": "<string>",
"issues": [
{
"path": [
"<string>"
],
"message": "<string>"
}
]
}