Skip to main content
GET
Get all agents

Authorizations

Authorization
string
header
required

API Key authorization header. Example: "Authorization: ApiKey {your-api-key}"

Authorization
string
header
required

OAuth 2.0 Bearer token. Example: "Authorization: Bearer {access-token}"

Query Parameters

pageIndex
integer<int32>

Page number (1-based). If provided with recordsPerPage, enables pagination.

recordsPerPage
integer<int32>

Number of records per page. If provided with pageIndex, enables pagination.

sortColumn
string
default:name

Column to sort by: name, lastActivity, created, updated, status, configType

sortOrder
integer<int32>
default:0

Sort order: 0 = ascending (default), 1 = descending

name
string

Filter by agent name (contains match, case-insensitive)

status
integer<int32>

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.

spaceId
integer<int32>

Filter by space ID

configType
enum<integer>

Filter by config type 1 = Agent; 2 = SharedFile; 3 = Template; 4 = Command

Available options:
1,
2,
3,
4
includeArchived
boolean
default:false

Response

Returns the list of agents (array without pagination, object with pagination)

agentTemplates
string | null
configType
enum<integer>

1 = Agent; 2 = SharedFile; 3 = Template; 4 = Command

Available options:
1,
2,
3,
4
description
string | null
documentation
string | null
icon
string | null
image
string<byte> | null
inputParameters
object | null
id
integer<int32> | null
isActive
boolean
read-only
lastActivity
string<date-time> | null
name
string | null
proxyPoolId
integer<int32> | null
spaceId
integer<int32> | null
startUrl
string | null
status
integer<int32> | null
userId
integer<int32> | null
validationStatus
enum<integer>

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)

Available options:
1,
2,
3
version
integer<int32>
created
string<date-time>
updated
string<date-time>