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

CreateChangeRequest

Create a new change request with planned schedule and impact scope

Execution Availability

Try It Out

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

Request Inputs

Body Fields

  • titleStringRequired

    Short summary title for the new change request

    Example: Upgrade database cluster to v14

  • descriptionStringRequired

    Detailed description of the change and its expected outcome

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

  • changeTypeStringRequired

    Change type

    Example: CHANGE_TYPE_UNSPECIFIED

  • plannedStartStringRequired

    Planned start

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

  • plannedEndStringRequired

    Planned end

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

Responses

200 OK

On success, this API returns the following response structure.

  • 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

Endpoint

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

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

Operation ID

CreateChangeRequest

Permalink

Request Example

curl -X POST '{host}/api/v1/change-management/change-requests' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"title":"Upgrade database cluster to v14","description":"Rolling upgrade of PostgreSQL from v13 to v14 with no downtime","changeType":"CHANGE_TYPE_UNSPECIFIED","plannedStart":"2026-01-15T08:00:00Z","plannedEnd":"2026-01-15T08:00:00Z","impactScope":{"entityType":"VmInstance","entityIds":"item1,item2"},"expectedAlerts":"item1,item2","changeOwner":"admin","approverIds":"item1,item2"}'

Response Example

200
{
  "id": "cr-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "title": "Upgrade database cluster to v14",
  "description": "Rolling upgrade of PostgreSQL from v13 to v14 with no downtime",
  "changeType": {},
  "status": {},
  "plannedStart": "example",
  "plannedEnd": "example",
  "impactScope": {}
}

Change History

This API has no change history records yet.

View all change history