Skip to main content
API Explorer|API Explorer
Infrastructure/Change Management
GETChangeManagementSince 1.0SynchronousAuth Required

ListChangeRequests

List change requests with optional status and time range filters

Execution Availability

Try It Out

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

Query Parameters

Request Inputs

Query Parameters

  • statusString

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

  • timeRangeString

    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

On success, this API returns the following response structure.

  • itemsList

    Collection of result items

    Example: (nested array)

    • idString

      Unique identifier of the change request

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

    • titleString

      Short summary title of the change request

      Example: Upgrade database cluster to v14

    • descriptionString

      Detailed description of the change and its expected impact

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

    • changeTypeString

      Change type

      Example: CHANGE_TYPE_UNSPECIFIED

    • statusString

      Status for this resource

      Example: CHANGE_STATUS_UNSPECIFIED

    • plannedStartString

      Planned start

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

    • plannedEndString

      Planned end

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

    • impactScopeObject

      Impact scope

      • entityTypeString

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

        Example: VmInstance

      • entityIdsList

        Entity ids

        Example: item1,item2

    • expectedAlertsList

      Expected alerts

      Example: item1,item2

    • changeOwnerString

      Username or ID of the person responsible for this change

      Example: admin

    • approverIdsList

      Approver ids

      Example: item1,item2

    • silenceIdString

      ID of the alert silence associated with this change window

      Example: silence-abc123

    • createdAtString

      Created at

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

  • totalInteger

    Total number of change requests matching the query

    Example: 10

  • limitInteger

    Maximum number of items returned per page

    Example: 20

  • offsetInteger

    Number of items skipped before the current page

    Example: 20

Endpoint

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

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

Operation ID

ListChangeRequests

Permalink

Request Example

curl -X GET '{host}/api/v1/change-management/change-requests' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "items": [
    {}
  ],
  "total": 10,
  "limit": 20,
  "offset": 20
}

Change History

This API has no change history records yet.

View all change history