Release Orchestrator API Reference

FieldValue
Source specrelease-orchestrator/openapi/scanner-events.v1.json
OpenAPI version3.1.1
API version1.0
Operations4
Path filterAll paths

Operations

POST /internal/v1/release-orchestrator/scanner-events/build-context/consumer-checkpoint

Register or renew the fixed Scanner consumer’s durable position for the authenticated tenant. Positions beyond the owner epoch/head are refused. Requires release:read and an authenticated tenant. Reporting also requires the configured Scanner client_id.

PropertyValue
Operation IDScannerEvents_BuildContextCatchUp_ConsumerCheckpoint
TagsRelease Orchestrator Scanner Events
AuthRequired
Request bodyapplication/json

Responses:

StatusDescriptionContent types
200OKapplication/json
400Bad Request-
401Unauthorized-
403Forbidden-
409Conflict-

GET /internal/v1/release-orchestrator/scanner-events/build-context/events

Read a bounded retained Scanner event page for the authenticated tenant. Epoch and retention gaps require explicit replay. Requires release:read and an authenticated tenant.

PropertyValue
Operation IDScannerEvents_BuildContextCatchUp
TagsRelease Orchestrator Scanner Events
AuthRequired
Request body-

Parameters:

NameInRequiredDescription
afterSeqqueryno
limitqueryno
streamEpochqueryno

Responses:

StatusDescriptionContent types
200OKapplication/json
400Bad Request-
401Unauthorized-
403Forbidden-

POST /internal/v1/release-orchestrator/scanner-events/scm-info/consumer-checkpoint

Register or renew the fixed Scanner consumer’s durable position for the authenticated tenant. Positions beyond the owner epoch/head are refused. Requires release:read and an authenticated tenant. Reporting also requires the configured Scanner client_id.

PropertyValue
Operation IDScannerEvents_ScmCatchUp_ConsumerCheckpoint
TagsRelease Orchestrator Scanner Events
AuthRequired
Request bodyapplication/json

Responses:

StatusDescriptionContent types
200OKapplication/json
400Bad Request-
401Unauthorized-
403Forbidden-
409Conflict-

GET /internal/v1/release-orchestrator/scanner-events/scm-info/events

Read a bounded retained Scanner event page for the authenticated tenant. Epoch and retention gaps require explicit replay. Requires release:read and an authenticated tenant.

PropertyValue
Operation IDScannerEvents_ScmCatchUp
TagsRelease Orchestrator Scanner Events
AuthRequired
Request body-

Parameters:

NameInRequiredDescription
afterSeqqueryno
limitqueryno
streamEpochqueryno

Responses:

StatusDescriptionContent types
200OKapplication/json
400Bad Request-
401Unauthorized-
403Forbidden-