curl --request GET \
--url http://localhost:9371/processesimport requests
url = "http://localhost:9371/processes"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://localhost:9371/processes', 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 => "9371",
CURLOPT_URL => "http://localhost:9371/processes",
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 := "http://localhost:9371/processes"
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("http://localhost:9371/processes")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:9371/processes")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"items": [
{
"id": 1,
"pid": 1,
"state": "queued",
"exitState": "failed",
"error": "<string>",
"createdAt": "<string>",
"completedAt": "<string>",
"ref": "<string>"
}
],
"nextCursor": "<string>",
"hasMore": true
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "rate_limit_exceeded",
"message": "<string>",
"retryAfter": 1
}{
"error": "<string>",
"code": "<string>"
}List processes
Returns process snapshots filtered by optional ref, state, and status query parameters. The status filter accepts the terminal exit states (success, failed, timeout, canceled) or ‘null’ to match processes that have not finished.
curl --request GET \
--url http://localhost:9371/processesimport requests
url = "http://localhost:9371/processes"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('http://localhost:9371/processes', 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 => "9371",
CURLOPT_URL => "http://localhost:9371/processes",
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 := "http://localhost:9371/processes"
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("http://localhost:9371/processes")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:9371/processes")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"items": [
{
"id": 1,
"pid": 1,
"state": "queued",
"exitState": "failed",
"error": "<string>",
"createdAt": "<string>",
"completedAt": "<string>",
"ref": "<string>"
}
],
"nextCursor": "<string>",
"hasMore": true
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "rate_limit_exceeded",
"message": "<string>",
"retryAfter": 1
}{
"error": "<string>",
"code": "<string>"
}Query Parameters
Optional reference string used to filter processes.
Current lifecycle state of a process.
queued, running, idle, terminating Filter processes by terminal exit state. Use 'null' to match processes that have not finished.
failed, success, timeout, canceled, null Opaque pagination token returned as nextCursor by the previous response. Pass it back unchanged to fetch the next page; null/omitted fetches the first page. Cursors encode position, not filters, so change filters only between pages when starting over.
2048Maximum number of items per page. Clamped to a maximum of 100; defaults to 20.
1 <= x <= 100Response
Matching processes.
Paginated collection envelope.
Processes that match the provided query filters.
Show child attributes
Show child attributes
Opaque cursor for the next page; null when there are no more items. Echo it back as the cursor query parameter to continue paginating.
Whether additional pages exist. When true, nextCursor is a valid cursor; when false, pagination has reached the end.
Was this page helpful?