Get rollback diff preview for a publish record

GET

/api/v2/agents/{agent_id}/publishes/{change_track_id}/diff

Purpose:
Returns a preview of what will change if the given publish is rolled back.
Two diffs are returned:

staging_diff: current staging → snapshot (what rollback will change in staging).

main_diff: current main → snapshot (what rolling back then publishing will change in production).

Path Parameters:

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

change_track_id (str): UUID of the publish record to preview rollback for.

Authorization:

Requires view permission on the agent.

Returns:

200: data — staging_diff and main_diff rollback previews.

400: Invalid API version.

403: Caller lacks view permission on the agent.

404: Agent, staging agent, or publish record not found.

500: Unexpected server error.

Current Version:

2.0.0

Request

Path Params

Header Params

Responses

🟢200

application/json

Rollback diff preview fetched successfully.

Body

🟠400

🟠403

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https:///api/v2/agents//publishes//diff' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "change_track_id": "8789aa94-66a2-49fc-8cb8-ca285ef42a88",
        "published_at": "2019-08-24T14:15:22.123Z",
        "published_by": "string",
        "staging_diff": {
            "has_changes": true,
            "agent": {
                "property1": "string",
                "property2": "string"
            },
            "instructions": {
                "property1": "string",
                "property2": "string"
            },
            "corpora": {
                "property1": "string",
                "property2": "string"
            },
            "tools": {
                "property1": "string",
                "property2": "string"
            },
            "guardrails": {
                "property1": "string",
                "property2": "string"
            },
            "sharepoint_folders": {
                "property1": "string",
                "property2": "string"
            }
        },
        "main_diff": {
            "has_changes": true,
            "agent": {
                "property1": "string",
                "property2": "string"
            },
            "instructions": {
                "property1": "string",
                "property2": "string"
            },
            "corpora": {
                "property1": "string",
                "property2": "string"
            },
            "tools": {
                "property1": "string",
                "property2": "string"
            },
            "guardrails": {
                "property1": "string",
                "property2": "string"
            },
            "sharepoint_folders": {
                "property1": "string",
                "property2": "string"
            }
        }
    }
}

Get publish history for an agent

Roll back staging agent to a previous publish