Sample - GitHub REST API
GET/orgs/{org}/private-registries/{secret_name}

Get a private registry for an organization

Get the configuration of a single private registry defined for an organization, omitting its encrypted value.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
orgstringrequired
The organization name. The name is not case sensitive.
secret_namestringrequired
The name of the secret.

2 status codes
200The specified private registry configuration for the organization
namestringrequired
The name of the private registry configuration.
registry_typestringrequired
The registry type.
Allowed:maven_repositorynuget_feedgoproxy_servernpm_registryrubygems_servercargo_registrycomposer_repositorydocker_registrygit_sourcehelm_registryhex_organizationhex_repository
auth_typestringoptional
The authentication type for the private registry.
Allowed:tokenusername_passwordoidc_azureoidc_awsoidc_jfrogoidc_cloudsmithoidc_gcp
urlstringoptional
The URL of the private registry.
usernamestringoptional
The username to use when authenticating with the private registry.
replaces_basebooleanoptional
Whether this private registry replaces the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When `true`, Dependabot will only use this registry and will not fall back to the public registry. When `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.
Default:false
visibilitystringrequired
Which type of organization repositories have access to the private registry.
Allowed:allprivateselected
tenant_idstringoptional
The tenant ID of the Azure AD application.
client_idstringoptional
The client ID of the Azure AD application.
aws_regionstringoptional
The AWS region.
account_idstringoptional
The AWS account ID.
role_namestringoptional
The AWS IAM role name.
domainstringoptional
The CodeArtifact domain.
domain_ownerstringoptional
The CodeArtifact domain owner.
jfrog_oidc_provider_namestringoptional
The JFrog OIDC provider name.
audiencestringoptional
The OIDC audience.
identity_mapping_namestringoptional
The JFrog identity mapping name.
namespacestringoptional
The Cloudsmith organization namespace.
service_slugstringoptional
The Cloudsmith service account slug.
api_hoststringoptional
The Cloudsmith API host.
workload_identity_providerstringoptional
The full resource name of the GCP Workload Identity Provider (e.g. `projects/<NUM>/locations/global/workloadIdentityPools/<POOL>/providers/<PROVIDER>`).
service_accountstringoptional
The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).
created_atstringrequired
updated_atstringrequired
404Resource not found
messagestringoptional
documentation_urlstringoptional
urlstringoptional
statusstringoptional

Error handling

A 404 is returned: Resource not found.