List agents
Returns a list of agents accessible to the authenticated user within their organization.
Supports optional pagination, filtering, and sorting. When pagination parameters are
provided, returns a paginated response with totalRecordCount. When no pagination
parameters are provided, returns a simple array for backward compatibility.
Filtering
-
name— filter by agent name (case-insensitive contains match) -
status— filter by last run status (RunStatusenum):- not provided: no filter
1Running4Queuing6Failure7Failed8Stopped9Completed10Success
Agents that have never run report
status = null. -
spaceId— filter by space ID -
configType— filter by config type
Sorting
sortColumn—name|lastActivity|created|updated|status|configType(default:name)sortOrder—0ascending (default) |1descending
Response format
- Without pagination params: array of agents (backward compatible)
- With pagination params:
{ agents: [...], totalRecordCount: N }
curl --request GET \
--url https://api.example.com/api/v1/agent/all \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/api/v1/agent/all"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/api/v1/agent/all', 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/api/v1/agent/all",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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/api/v1/agent/all"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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/api/v1/agent/all")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/agent/all")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"agentTemplates": "<string>",
"configType": 1,
"description": "<string>",
"documentation": "<string>",
"icon": "<string>",
"image": "aSDinaTvuI8gbWludGxpZnk=",
"inputParameters": {},
"id": 123,
"isActive": true,
"lastActivity": "2023-11-07T05:31:56Z",
"name": "<string>",
"proxyPoolId": 123,
"spaceId": 123,
"startUrl": "<string>",
"status": 123,
"userId": 123,
"validationStatus": 1,
"version": 123,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z"
}
]{
"statusCode": 123,
"statusDescription": "<string>",
"message": "<string>",
"severity": 0,
"errorCode": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}{
"type": "<string>",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>"
}Authorizations
API Key authorization header. Example: "Authorization: ApiKey {your-api-key}"
OAuth 2.0 Bearer token. Example: "Authorization: Bearer {access-token}"
Query Parameters
Page number (1-based). If provided with recordsPerPage, enables pagination.
Number of records per page. If provided with pageIndex, enables pagination.
Column to sort by: name, lastActivity, created, updated, status, configType
Sort order: 0 = ascending (default), 1 = descending
Filter by agent name (contains match, case-insensitive)
Filter by last run status (RunStatus: 0=Invalid, 1=Running, 2=Exporting, 3=Starting, 4=Queuing, 5=Stopping, 6=Failure, 7=Failed, 8=Stopped, 9=Completed, 10=Success, 11=Skipped, 12=Waiting). Agents that never ran have null status.
Filter by space ID
Filter by config type
1 = Agent; 2 = SharedFile; 3 = Template; 4 = Command
1, 2, 3, 4 Response
Returns the list of agents (array without pagination, object with pagination)
1 = Agent; 2 = SharedFile; 3 = Template; 4 = Command
1, 2, 3, 4 Show child attributes
Show child attributes
Semantic validation status of a config's most recently saved definition (e.g. whether every
fixed export schema column is actually produced by a command). Serialized as its underlying
int, not a string - see Sequentum.Enterprise.ControlCenter.Swagger.EnumDescriptionsSchemaFilter
for how these values get documented in the public OpenAPI spec. (1 = Unknown - Validation status was not computed for this response (e.g. a historical config version, which does not retain its own stored status); 2 = Invalid - The config has one or more semantic validation errors (e.g. a required export column with no producing command); 3 = Valid - The config has no semantic validation errors)
1, 2, 3