Skip to navigation

Publish a draft

Deprecated
View as Markdown

Deprecated on the v2 branch model. Migrate to POST /agent/{id}/branches/{branchId}/draft/publish. When ENABLE_BRANCH_MODEL is on, this endpoint returns 409 versioning_v2_migration_required with the Deprecation: true header. See the migration guide.

Publish a draft as a new versioned release. Optionally activate it immediately.

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Path parameters

idstringRequiredformat: "^[a-f\d]{24}$"
The agent ID.
draftIdstringRequired
The draft ID

Request

This endpoint expects an object.
labelstring or nullOptional<=200 characters
Label for the published version
descriptionstring or nullOptional<=2000 characters
Description of the published version
activatebooleanOptionalDefaults to false
Whether to immediately activate the version after publishing

Response

Draft published as a new version
statusbooleanOptional
dataobjectOptional
Represents either a draft revision or a published version of an agent's configuration.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error