Returns the collection coverage of one opened source registration, selected by ?source_id, ?source_revision and ?environment_ref: the current run's result, and the last qualified run when its scope has one.

GET

/v1/m/inventory/collections

curl --request GET \
  --url 'https://example.com/v1/m/inventory/collections?source_id=example&source_revision=1&environment_ref=example' \
  --header 'Authorization: Bearer <token>'

• this engine

Returns the collection coverage of one opened source registration, selected by ?source_id, ?source_revision and ?environment_ref: the current run’s result, and the last qualified run when its scope has one.

Authorizations

• bearerAuth
• browserSession

Parameters

Header Parameters

X-Olivares-Tenant

string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Query Parameters

source_id

required

string

>= 1 characters

Source ID from the caller’s CURRENT opened registration; nonempty, at most 128 bytes. An old selector reads that historical selection, not the current roster.

source_revision

required

integer format: int64

>= 1

Positive signed 64-bit revision from the same CURRENT opened registration; missing or invalid selectors return 400.

environment_ref

required

string

>= 1 characters

Environment from the same CURRENT opened registration; nonempty, at most 128 bytes. Unmatched selection returns unknown coverage.

Responses

200

Collection evidence for the caller-selected CURRENT opened registration. An unmatched selection returns unknown, never inherited completeness. Current enumeration and projection are separate from historical last_qualified_success for the exact scope. Complete describes this query over its observed interval, not a global snapshot or provider authorization. Empty completion does not delete resources.

Media type application/json

object

cursor

Optional list-envelope continuation cursor; this exact source selection has at most one head.

string

has_more

required

List-envelope continuation flag, not evidence of collection completeness.

boolean

items

required

Array<object>

>= 1 items <= 1 items

object

current

required

object

admitted_count

required

integer format: int64

<= 100000

committed_count

required

integer format: int64

<= 100000

coverage

required

string

Allowed values: complete partial unavailable unsupported unknown

environment_ref

required

string

>= 1 characters

expected_count

required

integer format: int64

<= 100000

family

string

Allowed values: azure.resource

fulfilled_scope

SHA-256 fingerprint of the versioned query scope.

string

/^[0-9a-f]{64}$/

host_finished_at

Host closure after Gather returns.

string format: date-time

host_started_at

required

Host start as an RFC3339 timestamp; empty when the selected registration has no run.

string

producer_finished_at

Producer-declared enumeration end.

string format: date-time

producer_started_at

Producer-declared enumeration start.

string format: date-time

projection

required

Queued members are pending until their receipt/materialization commits; enumeration alone cannot qualify them.

string

Allowed values: pending committed failed

qualified_at

Inventory qualification after all expected members commit.

string format: date-time

reason

required

string

Allowed values: "" exhausted page_limit repeated_cursor invalid_response scope_unproven scope_mismatch provider_error offline disabled member_limit missing_report protocol_error gather_error canceled sink_error persistence_rejected commit_outcome_unknown persistence_canceled persistence_unavailable persistence_error

rejection_reason

string

Allowed values: terminal_conflict linkage_conflict member_conflict receipt_conflict

requested_scope

SHA-256 fingerprint of the versioned query scope.

string

/^[0-9a-f]{64}$/

run_id

required

Host run ID; empty when the selected registration has no run.

string

run_order

required

Durable source order; zero when no run exists.

integer format: int64

scope_contract

string

Allowed values: azure-resource-graph/2022-10-01/id-v1

source_id

required

string

>= 1 characters

source_revision

required

integer format: int64

>= 1

last_qualified_success

Immutable historical qualification for this exact registration and scope; absent until one run qualifies. Later rejection evidence does not rewrite this receipt.

object

environment_ref

required

string

>= 1 characters

expected_count

required

integer format: int64

<= 100000

family

required

string

Allowed values: azure.resource

fulfilled_scope

required

SHA-256 fingerprint of the versioned query scope.

string

/^[0-9a-f]{64}$/

host_finished_at

required

Host closure after Gather returns.

string format: date-time

host_started_at

required

Host run start, separate from producer observation time.

string format: date-time

producer_finished_at

required

Producer-declared enumeration end.

string format: date-time

producer_started_at

required

Producer-declared enumeration start.

string format: date-time

qualified_at

required

Inventory qualification after all expected members commit.

string format: date-time

requested_scope

required

SHA-256 fingerprint of the versioned query scope.

string

/^[0-9a-f]{64}$/

run_id

required

Host-owned collection run ID.

string

scope_contract

required

string

Allowed values: azure-resource-graph/2022-10-01/id-v1

source_id

required

string

>= 1 characters

source_revision

required

integer format: int64

>= 1

Example

{
  "items": [
    {
      "current": {
        "coverage": "complete",
        "family": "azure.resource",
        "projection": "pending",
        "reason": "",
        "rejection_reason": "terminal_conflict",
        "scope_contract": "azure-resource-graph/2022-10-01/id-v1"
      },
      "last_qualified_success": {
        "family": "azure.resource",
        "scope_contract": "azure-resource-graph/2022-10-01/id-v1"
      }
    }
  ]
}

400

Bad request

Media type application/json

object

Example ^generated

{}

401

Unauthenticated

Media type application/json

object

Example ^generated

{}

403

Forbidden

Media type application/json

object

Example ^generated

{}

404

Not found

Media type application/json

object

Example ^generated

{}

409

Conflict / setup required

Media type application/json

object

Example ^generated

{}

423

Tenant service suspended or not in service

Media type application/json

object

Example ^generated

{}

429

Rate limited

Media type application/json

object

Example ^generated

{}

500

Stored collection evidence or store read failed; the generic error body contains no backend detail

Media type application/json

object

Example ^generated

{}