Change Requests
ChangeRequestsService manages long-running operational requests such as quota increases. Requests may take minutes to days to complete and may involve external provider workflows.
Base path: /change-requests
POST /change-requests/CreateChangeRequest
Section titled “POST /change-requests/CreateChangeRequest”CreateChangeRequest creates a new change request (or returns an existing open one).
Request (CreateChangeRequestRequest)
| Field | Type | Description |
|---|---|---|
type | ChangeRequestType | type: The kind of change/quota increase to request. |
idempotency_key | string? | idempotency_key: Optional safe retry key for button-click retries (e.g. a UUID from the UI). |
conflict_behavior | ConflictBehavior? | conflict_behavior: What to do when an open request of the same type already exists. Default is RETURN_EXISTING_OPEN (idempotent / safe for UI retries). |
Response (CreateChangeRequestResponse)
| Field | Type | Description |
|---|---|---|
request | ChangeRequest | request: The newly created (or returned existing) change request. |
reused_existing_open | bool | reused_existing_open: True when an existing open request was returned instead of creating a new one. |
POST /change-requests/GetChangeRequest
Section titled “POST /change-requests/GetChangeRequest”GetChangeRequest retrieves a specific change request by ID.
Request (GetChangeRequestRequest)
| Field | Type | Description |
|---|---|---|
request_id | string | request_id: The change request to retrieve. |
Response (GetChangeRequestResponse)
| Field | Type | Description |
|---|---|---|
request | ChangeRequest | request: The requested change request. |
POST /change-requests/ListChangeRequests
Section titled “POST /change-requests/ListChangeRequests”ListChangeRequests lists all change requests for the tenant, newest-first.
Request (ListChangeRequestsRequest)
| Field | Type | Description |
|---|---|---|
page_size | int32? | page_size: Maximum number of results per page (default: 20, max: 200). Results are newest-first. |
page_token | string? | page_token: Token from previous response to retrieve the next page. |
type | ChangeRequestType? | type: Filter to a specific request type. Omit to return all types. |
status | ChangeRequestStatus[] | status: Filter to specific statuses. Omit to return all statuses. |
Response (ListChangeRequestsResponse)
| Field | Type | Description |
|---|---|---|
requests | ChangeRequest[] | requests: Change requests for this page, newest-first. |
next_page_token | string? | next_page_token: Token for the next page. Empty when no more results. |
POST /change-requests/ListChangeRequestEvents
Section titled “POST /change-requests/ListChangeRequestEvents”ListChangeRequestEvents returns the append-only event history for a specific request.
Request (ListChangeRequestEventsRequest)
| Field | Type | Description |
|---|---|---|
request_id | string | request_id: The change request whose event history to retrieve. |
page_size | int32? | page_size: Maximum number of events per page (default: 50, max: 500). |
page_token | string? | page_token: Token from previous response to retrieve the next page. |
Response (ListChangeRequestEventsResponse)
| Field | Type | Description |
|---|---|---|
events | ChangeRequestEvent[] | events: Events for this page, oldest-first. |
next_page_token | string? | next_page_token: Token for the next page. Empty when no more results. |
POST /change-requests/ProvideChangeRequestInfo
Section titled “POST /change-requests/ProvideChangeRequestInfo”ProvideChangeRequestInfo submits follow-up information for a request in ACTION_REQUIRED status.
Request (ProvideChangeRequestInfoRequest)
| Field | Type | Description |
|---|---|---|
request_id | string | request_id: The change request to provide follow-up information for. |
Response (ProvideChangeRequestInfoResponse)
| Field | Type | Description |
|---|---|---|
request | ChangeRequest | request: The updated change request after the info was provided. |
POST /change-requests/CancelChangeRequest
Section titled “POST /change-requests/CancelChangeRequest”CancelChangeRequest cancels an open request.
Request (CancelChangeRequestRequest)
| Field | Type | Description |
|---|---|---|
request_id | string | request_id: The change request to cancel. |
reason | string? | reason: Optional cancellation reason for the audit trail. |
Response (CancelChangeRequestResponse)
| Field | Type | Description |
|---|---|---|
request | ChangeRequest | request: The updated change request with CANCELED status. |