Skip to main content
POST
Discover a registry connection

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization
string | null
x-ankra-organisation-id
string | null

Body

application/json
admin_credential_name
string
required

The organisation's registry credential to act as.

url
string
required

The registry, as a host or an oci:// or https:// URL. A Harbor URL may name a project, which is ignored; a Google Artifact Registry URL names at least the Google Cloud project (oci://-docker.pkg.dev/[/], oci://gcr.io/).

Response

Successful Response

detail
string
required

A sentence saying what Ankra reached and saw, or why it could not.

host
string
required
ok
boolean
required

True when the admin credential could list the registry's projects.

projects
DiscoveredRegistryProject · object[]
required

The projects (Harbor) or Docker repositories (Google Artifact Registry) the credential sees, by name; empty when ok is false.

provider
enum<string>
required
Available options:
harbor,
google_artifact_registry,
oci
truncated
boolean
required

True when the registry holds more than the 500 projects answered.