Skip to main content
POST
cURL

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

Body

The new content, commit comments, and optional expected version

Request body for uploading a new version of an agent's content.

comments
string
required

A mandatory commit message describing the change, stored alongside the new version.

Minimum string length: 1
Example:

"Point at the new start URL"

content
any

The agent's full config as a JSON object - the same shape returned by the download endpoints' default format=json (not the plain-text NestedText produced by format=yaml). Must be a JSON object.

Example:
expectedVersion
integer<int32> | null

Optional optimistic-concurrency guard. When set, the upload is rejected with a conflict if the agent's current version does not match this value.

Response

The new version was created

Result of uploading a new version of an agent's content. Semantic validation errors do not prevent the version from being created - they are returned alongside it so the caller can decide whether to fix them.

agentId
integer<int32>

The ID of the agent this content belongs to.

newVersion
integer<int32>

The newly created version number.

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
errors
object[] | null

Semantic validation errors, if any. Non-empty only when validationStatus is 2 (Invalid) - these do not prevent the version from being created.