Skip to main content
ZStack
Infrastructure/Change Management

ListChangeRequests

List change requests with optional status and time range filters

GET/api/v1/change-management/change-requests

Operation ID

ListChangeRequests

Since

1.0.0

Execution Mode

Synchronous

Auth Context

Auth Required

Auth Context

Send these values as request headers when calling this API.

AuthorizationstringRequired

Bearer Token

X-Tenant-IDstring

X-Tenant-ID

Request Inputs

Query Parameters

  • status
    String

    Filter by change request status, e.g. PENDING_APPROVAL, APPROVED Filter by change request status, e.g. PENDING_APPROVAL, APPROVED

  • timeRange
    String

    Time range filter, e.g. 7d, 30d, or custom ISO range Time range filter, e.g. 7d, 30d, or custom ISO range

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • items
    List

    Collection of result items

    Example: (nested array)

    • id
      String

      Unique identifier of the change request

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

    • title
      String

      Short summary title of the change request

      Example: Upgrade database cluster to v14

    • description
      String

      Detailed description of the change and its expected impact

      Example: Rolling upgrade of PostgreSQL from v13 to v14 with no downtime

    • changeType
      String

      Change type

      Example: CHANGE_TYPE_UNSPECIFIED

    • status
      String

      Status for this resource

      Example: CHANGE_STATUS_UNSPECIFIED

    • plannedStart
      String

      Planned start

      Example: 2026-01-15T08:00:00Z

    • plannedEnd
      String

      Planned end

      Example: 2026-01-15T08:00:00Z

    • impactScope
      Object

      Impact scope

      • entityType
        String

        Resource type affected by this change, e.g. VmInstance or Network

        Example: VmInstance

      • entityIds
        List

        Entity ids

        Example: item1,item2

    • expectedAlerts
      List

      Expected alerts

      Example: item1,item2

    • changeOwner
      String

      Username or ID of the person responsible for this change

      Example: admin

    • approverIds
      List

      Approver ids

      Example: item1,item2

    • silenceId
      String

      ID of the alert silence associated with this change window

      Example: silence-abc123

    • createdAt
      String

      Created at

      Example: 2026-01-15T08:00:00Z

  • total
    Integer

    Total number of change requests matching the query

    Example: 10

  • limit
    Integer

    Maximum number of items returned per page

    Example: 20

  • offset
    Integer

    Number of items skipped before the current page

    Example: 20