Skip to main content
GET
Get a single agent

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}"

Path Parameters

agentId
integer<int32>
required

The ID of the agent to retrieve

Response

Returns the requested agent

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>