Get publish history for an agent

GET

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

Purpose:
Returns the publish history for an agent. Each entry represents one
time staged changes were promoted to the published agent, and includes a
publish ID, timestamp, and the user who triggered it.

Path Parameters:

agent_id (int): Unique identifier of the agent.

Query Parameters:

paginated (bool, optional): Enable pagination. Valid values: "true", "false". Default: "false".

page (int, optional): Page number. Only used when paginated=true. Default: 1.

items_per_page (int, optional): Items per page. Only used when paginated=true. Default: 10.

Authorization:

Requires view permission on the agent.

Returns:

200: data.items — list of publish records; data.meta — pagination info (null when paginated=false).

400: Invalid API version.

403: Caller lacks view permission on the agent.

404: Agent not found.

500: Unexpected server error.

Current Version:

2.0.0

Request

Path Params

Query Params

Header Params

Responses

🟢200

application/json

Publish history fetched successfully.

Body

🟠400

🟠403

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https:///api/v2/agents//publishes?items_per_page&page&paginated' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "items": [
            {
                "change_track_id": "8789aa94-66a2-49fc-8cb8-ca285ef42a88",
                "published_at": "2019-08-24T14:15:22.123Z",
                "published_by": "string"
            }
        ],
        "meta": {
            "count": 0,
            "num_pages": 0,
            "current_page": 0
        }
    }
}

Get Staging Diff

Get rollback diff preview for a publish record