Skip to main content
API Explorer|API Explorer
Infrastructure/OTA Upgrade Plans
GETOTASince 1.0SynchronousAuth Required

GetPlanSummary

Retrieve a summary of a graduated upgrade plan with batch statistics

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Path Parameters

Request Inputs

Path Parameters

  • planIdStringRequired

    ID of the graduated plan to summarize

Responses

200 OK

On success, this API returns the following response structure.

  • planIdString

    ID of the graduated plan this summary covers

    Example: plan-a1b2c3d4-e5f6-7890-abcd-ef1234567890

  • statusString

    Current overall status of the graduated plan

    Example: running

  • totalAgentsInteger

    Total number of agents targeted by this plan

    Example: 50

  • completedCountInteger

    Number of agents that have successfully completed the upgrade

    Example: 30

  • failedCountInteger

    Number of agents that have failed the upgrade

    Example: 2

  • pendingCountInteger

    Number of agents that have not yet started the upgrade

    Example: 18

  • failureRateLong

    Current failure rate as a fraction of total targeted agents

    Example: 0.04

Endpoint

GET/api/v1/lifecycle/upgrade-plans/{planId}/summary

/api/v1/lifecycle/upgrade-plans/{planId}/summary

Operation ID

GetPlanSummary

Permalink

Request Example

curl -X GET '{host}/api/v1/lifecycle/upgrade-plans/{planId}/summary' -H 'Authorization: Bearer {token}'

Response Example

200
{"planId": "plan-a1b2c3d4-e5f6-7890-abcd-ef1234567890", "status": "running", "totalAgents": 50, "completedCount": 30, "failedCount": 2, "pendingCount": 18, "failureRate": 0.04}

Change History

This API has no change history records yet.

View all change history