Skip to content
Proud to collaborate with Microsoft for Startups

registry.inventory.read ​

Read local container registry inventory from the aggregated catalog

Read a local container-registry inventory snapshot.

Inputs:

  • organization_uuid: Organization UUID (required)
  • provider/backend_type/account_sync_status/repository_sync_status filters (optional)
  • registry_account_uuid/registry_repository_uuid/repository_full_name filters (optional)
  • include_repositories/include_images/include_versions toggles (optional)
  • limit/offset page registry accounts

Outputs:

  • accounts: registry accounts with optional nested repositories, images, and versions
  • account_count, repository_count, image_count, image_version_count, tag_count
  • providers_present, sync_statuses_present, warnings
  • read_at and error

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-registry
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—Organization UUID for tenant isolation
providerstringNo—Optional provider family filter such as aws, github, gcp, azure, or gitlab
backend_typestringNo—Optional RegistryBackendType value/name filter such as ecr or GITHUB_GHCR
account_sync_statusstringNo—Optional RegistryAccount sync-status filter
repository_sync_statusstringNo—Optional RegistryRepository sync-status filter
registry_account_uuiduuidNo—Restrict inventory to one RegistryAccount
registry_repository_uuiduuidNo—Restrict inventory to one RegistryRepository
repository_full_namestringNo—Restrict inventory to an exact repository full_name
repository_name_containsstringNo—Case-insensitive repository full_name substring filter
tagstringNo—Restrict included versions to an exact tag
digeststringNo—Restrict included images/versions to an exact digest
include_repositoriesbooleanNo—Include repository summaries; default true
include_imagesbooleanNo—Include image summaries under repositories; default false
include_versionsbooleanNo—Include tag/version summaries under images; implies include_images
limitintegerNo—Maximum registry accounts to return; default 50, capped at 100
offsetintegerNo—Pagination offset for registry accounts
workflow_run_idstringNo—Engine-stamped workflow_run_id when invoked as a DAG step (ADR-015 E1)

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidYes—Organization UUID for tenant isolation
providerstringNo—Optional provider family filter such as aws, github, gcp, azure, or gitlab
backend_typestringNo—Optional RegistryBackendType value/name filter such as ecr or GITHUB_GHCR
account_sync_statusstringNo—Optional RegistryAccount sync-status filter
repository_sync_statusstringNo—Optional RegistryRepository sync-status filter
registry_account_uuiduuidNo—Restrict inventory to one RegistryAccount
registry_repository_uuiduuidNo—Restrict inventory to one RegistryRepository
repository_full_namestringNo—Restrict inventory to an exact repository full_name
repository_name_containsstringNo—Case-insensitive repository full_name substring filter
tagstringNo—Restrict included versions to an exact tag
digeststringNo—Restrict included images/versions to an exact digest
include_repositoriesbooleanNo—Include repository summaries; default true
include_imagesbooleanNo—Include image summaries under repositories; default false
include_versionsbooleanNo—Include tag/version summaries under images; implies include_images
limitintegerNo—Maximum registry accounts to return; default 50, capped at 100
offsetintegerNo—Pagination offset for registry accounts
workflow_run_idstringNo—Engine-stamped workflow_run_id when invoked as a DAG step (ADR-015 E1)
accountslistYes—Registry accounts with optional nested repositories, images, and versions
account_countintegerYes—Number of accounts returned in this page
repository_countintegerYes—Number of matching repositories under returned accounts
image_countintegerYes—Number of matching images under returned repositories
image_version_countintegerYes—Number of matching image-version rows under returned repositories
tag_countintegerYes—Number of matching tagged image-version rows under returned repositories
providers_presentlistYes—Provider families present in returned accounts
sync_statuses_presentlistYes—Registry sync statuses present across returned accounts and repositories
warningslistYes—Non-fatal inventory read warnings
read_atstringYes—ISO-8601 timestamp when the local inventory snapshot was read
errorstringNo—Soft read/validation error when the inventory cannot be read
failure_reasonstringNo—Engine failure reason, present only on failed terminal state
failure_typestringNo—Engine failure type classification (ADR-015 E2)
failed_actionstringNo—Action name that caused the failure (ADR-015 E2)
failed_at_statestringNo—State name where the failure occurred
failed_stepstringNo—Failed DAG step name when reported by the engine
failed_layerintegerNo—1-based failed DAG layer number emitted by the engine
error_typestringNo—Unexpected error class or type

States ​

StateInitialTerminalSuccessAuto-advanceDescription
doneYesYesYes——

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "registry.inventory.read",
  "initial_data": {
    "organization_uuid": "value"
  }
}