Register a durable change consumer at the current baseline
POST /api/v1/projects/{projectId}/environments/{environmentId}/changes/consumers
Choose a stable UUID to retry registration safely. Query current state after registration, then consume and explicitly acknowledge changes. Registrations retain unread changes until removed.
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
projectId | string | required | Identifies the Project that owns the addressed resource. Applies to Register a durable change consumer at the current baseline. |
environmentId | string | required | Identifies the Project environment addressed by the operation. Applies to Register a durable change consumer at the current baseline. |
Request body
Required — Request body for: Register a durable change consumer at the current baseline.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
consumerId | string | required |
Responses
| Status | Description | Body |
|---|---|---|
200 | Response for status 200 | application/json — object — consumerId: string (required); cursor: string (required); position: string (required) |
400 | The request is malformed or cannot be processed. | application/json — PublicApiError — error: object (required) |
401 | Authentication failed. The Authorization header is missing, or the credential is invalid or expired. | application/json — PublicApiError — error: object (required) |
403 | Access denied. The authenticated user does not have permission to perform this action. | application/json — PublicApiError — error: object (required) |
404 | Resource not found. | application/json — PublicApiError — error: object (required) |
409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json — PublicApiError — error: object (required) |
422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json — PublicApiError — error: object (required) |
429 | Too many requests. | application/json — PublicApiError — error: object (required) |
500 | The server could not complete the request. | application/json — PublicApiError — error: object (required) |
503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json — PublicApiError — error: object (required) |