Upcoming browser-session canonical read. Set to '1' to capture the authorized response and a signed Workspace replay cursor in one snapshot. Apply every required retained read before acknowledging a socket checkpoint. Failed or incomplete reads return no cursor.
Values
1
Responses
ETag
string
Quoted decimal optimistic-concurrency version.
X-Assign-Realtime-Cursor
string·max 4096
Signed Workspace/User/session-bound replay custody; present only after a successful requested canonical baseline.
X-Assign-Realtime-Position
string
Decimal-string snapshot position; present only with a successful baseline cursor.
idRequired
string <uuid>
Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
Example0198ac5e-f9b7-7000-8000-000000000001
workspace_idRequired
string <uuid>
Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
Example0198ac5e-f9b7-7000-8000-000000000001
definitionRequired
object
statusRequired
string
Values
activepaused
scope_kindRequired
string
Values
workspaceprojects
project_idsRequired
string <uuid>[]·max 1000
Empty for Workspace scope and non-empty for selected-Projects scope.
enabled_trigger_typesRequired
string[]·min 1·max 3
Values
manualeventschedule
additional_instructionsRequired
string·max 2000
schedule_timezoneRequired
string·min 1·max 100
schedule_local_timeRequired
string
schedule_weekdaysRequired
integer[]·min 1·max 7
schedule_interval_minutesRequired
Fixed recurrence interval. Zero uses the local-time weekday schedule.
next_scheduled_atRequired
string <date-time>
Next occurrence as an unambiguous UTC instant; clients render it with schedule_timezone and the local offset.
Example2026-08-15T12:00:00Z
quarantined_atRequired
string <date-time>
RFC 3339 timestamp in UTC.
Example2026-08-15T12:00:00Z
quarantine_reasonRequired
string·max 200
removed_atRequired
string <date-time>
RFC 3339 timestamp in UTC.
Example2026-08-15T12:00:00Z
rollback_definition_versionRequired
string·max 100
revisionRequired
integer <int64>·min 1
created_atRequired
string <date-time>
RFC 3339 timestamp in UTC.
Example2026-08-15T12:00:00Z
updated_atRequired
string <date-time>
RFC 3339 timestamp in UTC.
Example2026-08-15T12:00:00Z
catalog_updated_at
string
UTC RFC3339 instance sort position on catalog list items; absent from detail and mutation responses.
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
errorRequired
object
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
errorRequired
object
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
errorRequired
object
Retry-After
integer·min 0
Delay in seconds before retrying, when an expected maintenance end is known.
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
