MethodPathSummaryAuth
GET/v1/admin/package-monitor/alertsList current package-monitor alert heads in an explicit tenant scopeSession
GET/v1/admin/package-monitor/alerts/{alert_id}/transitionsList immutable transition facts in an explicit tenant scopeSession
GET/v1/admin/package-monitor/alerts/{alert_id}/transitions/{revision}Get one immutable transition fact in an explicit tenant scopeSession
GET/v1/admin/package-monitor/policiesList current package-monitor policies in an explicit tenant scopeSession

Contract file:api/control-package-monitor.openapi.yaml

Operation details

GET /v1/admin/package-monitor/alerts

List current package-monitor alert heads in an explicit tenant scope

operationId
listAdminPackageMonitorAlerts
Auth
  • Session: the Bearer session of a signed-in control plane user, used by the customer in their own control plane; a plugin must never ask for it.
Required permissions

The contract has no separate permission annotation; see the description below and the 403 response.

Description (from the contract)

Platform callers must provide scope_id explicitly and require billing.adjustments.manage or platform.admin.

Parameters

listAdminPackageMonitorAlerts Parameters
NameInTypeRequiredDescription
scope_idquerystring(uuid)Yes—
limitqueryintegerNo—
cursorquerystringNo—
current_phasequerystring: before / triggered / recovered / suppressed_staleNoExact alert phase projected from the latest immutable receipt in the frozen snapshot.
threshold_idquerystringNoExact lowercase SHA-256 threshold identity. Input-only and never returned.

Responses

listAdminPackageMonitorAlerts Responses
StatusDescription
200Stable keyset page of current alert heads.

Fields:items: array<PackageMonitorAlertHead> next_cursor?: string

400Invalid request
401Authentication required
403Permission denied
405Method not allowed
408Request cancelled
503Dependency unavailable

What to do on failure

  • 400 Fix the parameters or body per the field list; do not retry unchanged.
  • 401 Check the credential format and whether it expired or was rotated.
  • 403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.
  • 503 A dependency is unavailable: retry later with the original Idempotency-Key.

↑ Back to list

GET /v1/admin/package-monitor/alerts/{alert_id}/transitions

List immutable transition facts in an explicit tenant scope

operationId
listAdminPackageMonitorTransitions
Auth
  • Session: the Bearer session of a signed-in control plane user, used by the customer in their own control plane; a plugin must never ask for it.
Required permissions

The contract has no separate permission annotation; see the description below and the 403 response.

Description (from the contract)

Platform callers must provide scope_id explicitly. The first page freezes the alert head revision. The signed cursor is bound to the exact phase filter, including an explicit empty filter.

Parameters

listAdminPackageMonitorTransitions Parameters
NameInTypeRequiredDescription
alert_idpathstring(uuid)Yes—
scope_idquerystring(uuid)Yes—
limitqueryintegerNo—
cursorquerystringNo—
phasequerystring: before / triggered / recovered / suppressed_staleNoExact immutable threshold transition phase.

Responses

listAdminPackageMonitorTransitions Responses
StatusDescription
200Frozen-revision keyset page of immutable transition facts.

Fields:items: array<PackageMonitorTransition> next_cursor?: string

400Invalid request
401Authentication required
403Permission denied
404Resource not found
405Method not allowed
408Request cancelled
503Dependency unavailable

What to do on failure

  • 400 Fix the parameters or body per the field list; do not retry unchanged.
  • 401 Check the credential format and whether it expired or was rotated.
  • 403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.
  • 404 The resource does not exist or belongs to another tenant.
  • 503 A dependency is unavailable: retry later with the original Idempotency-Key.

↑ Back to list

GET /v1/admin/package-monitor/alerts/{alert_id}/transitions/{revision}

Get one immutable transition fact in an explicit tenant scope

operationId
getAdminPackageMonitorTransition
Auth
  • Session: the Bearer session of a signed-in control plane user, used by the customer in their own control plane; a plugin must never ask for it.
Required permissions

The contract has no separate permission annotation; see the description below and the 403 response.

Description (from the contract)

Platform callers must provide scope_id explicitly.

Parameters

getAdminPackageMonitorTransition Parameters
NameInTypeRequiredDescription
alert_idpathstring(uuid)Yes—
revisionpathinteger(int64)Yes—
scope_idquerystring(uuid)Yes—

Responses

getAdminPackageMonitorTransition Responses
StatusDescription
200One immutable transition fact.

Fields:alert_id: string(uuid) revision: integer(int64) subscription_id: string(uuid) policy_id: string(uuid) policy_revision: integer(int64) metric: string: traffic_bytes / bandwidth_bps / connections / expiration period_key: string phase: string: before / triggered / recovered / suppressed_stale observed_value: string metric_schema_version: string: package-monitor-metric/v1 / deadline/v1 source_watermark: string observed_at: string(date-time) finalized_through: string(date-time) evaluated_at: string(date-time) reason_code: string

400Invalid request
401Authentication required
403Permission denied
404Resource not found
405Method not allowed
408Request cancelled
503Dependency unavailable

What to do on failure

  • 400 Fix the parameters or body per the field list; do not retry unchanged.
  • 401 Check the credential format and whether it expired or was rotated.
  • 403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.
  • 404 The resource does not exist or belongs to another tenant.
  • 503 A dependency is unavailable: retry later with the original Idempotency-Key.

↑ Back to list

GET /v1/admin/package-monitor/policies

List current package-monitor policies in an explicit tenant scope

operationId
listAdminPackageMonitorPolicies
Auth
  • Session: the Bearer session of a signed-in control plane user, used by the customer in their own control plane; a plugin must never ask for it.
Required permissions

The contract has no separate permission annotation; see the description below and the 403 response.

Description (from the contract)

Platform callers must provide scope_id explicitly and require billing.adjustments.manage or platform.admin.

Parameters

listAdminPackageMonitorPolicies Parameters
NameInTypeRequiredDescription
scope_idquerystring(uuid)Yes—
limitqueryintegerNo—
cursorquerystringNo—

Responses

listAdminPackageMonitorPolicies Responses
StatusDescription
200Stable keyset page of current policy heads.

Fields:items: array<PackageMonitorPolicy> next_cursor?: string

400Invalid request
401Authentication required
403Permission denied
405Method not allowed
408Request cancelled
503Dependency unavailable

What to do on failure

  • 400 Fix the parameters or body per the field list; do not retry unchanged.
  • 401 Check the credential format and whether it expired or was rotated.
  • 403 Check the key scopes, the owner’s current permissions and the tenant scope; never switch to a more privileged account.
  • 503 A dependency is unavailable: retry later with the original Idempotency-Key.

↑ Back to list