Roll back staging agent to a previous publish

PUT

/api/v2/agents/{agent_id}/rollback

Purpose:
Restores the staging agent to the state it was in at a previous
publish. Only the staging agent is affected — the published agent is
unchanged.

Note (staging-agent feature flag ON): after rolling back, use the
Publish API (POST api/v2/agents/{agent_id}/staging/publish) to propagate the
restored state to the published agent.

Path Parameters:

agent_id (int): Unique identifier of the published agent.

Request Body:

change_track_id (str): UUID of the publish record to roll back to.

Authorization:

Requires manage permission on the agent.

Returns:

200: data.staging_agent_id — ID of the updated staging agent; data.change_track_id — ID of the rolled-back publish record.

400: change_track_id is missing or the API version is invalid.

403: Caller lacks manage permission on the agent.

404: Agent or publish record not found.

500: Unexpected server error.

Current Version:

2.0.0

Request

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Staging agent rolled back to selected publish successfully.

Body

🟠400

🟠403

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request PUT 'https:///api/v2/agents//rollback' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "change_track_id": "8789aa94-66a2-49fc-8cb8-ca285ef42a88"
}'

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "staging_agent_id": 0,
        "change_track_id": "8789aa94-66a2-49fc-8cb8-ca285ef42a88"
    }
}

Get rollback diff preview for a publish record

Publish staging agent to main