Skip to main content
ZStack
Infrastructure/Change Management

CreateChangeRequest

Create a new change request with planned schedule and impact scope

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

Operation ID

CreateChangeRequest

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

application/json

Body Fields

  • title
    StringRequired

    Short summary title for the new change request

    Example: Upgrade database cluster to v14

  • description
    StringRequired

    Detailed description of the change and its expected outcome

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

  • changeType
    StringRequired

    Change type

    Example: CHANGE_TYPE_UNSPECIFIED

  • plannedStart
    StringRequired

    Planned start

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

  • plannedEnd
    StringRequired

    Planned end

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

Responses

200 OK
200 OK

On success, this API returns the following response structure.

  • 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