Sign in

v56

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-011,4581,08113.3 MB
private-registries

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.

get/orgs/{org}/private-registries/{secret_name}

Path parameters

orgstring required

The organization name. The name is not case sensitive.

secret_namestring required

The name of the secret.

Response

The specified private registry configuration for the organization

namestring required

The name of the private registry configuration.

registry_type'maven_repository' | 'nuget_feed' | 'goproxy_server' | 'npm_registry' | 'rubygems_server' | 'cargo_registry' | 'composer_repository' | 'docker_registry' | 'git_source' | 'helm_registry' | 'hex_organization' | 'hex_repository' | 'pub_repository' | 'python_index' | 'terraform_registry' required

The registry type.

auth_type'token' | 'username_password' | 'oidc_azure' | 'oidc_aws' | 'oidc_jfrog' | 'oidc_cloudsmith' | 'oidc_gcp'

The authentication type for the private registry.

urlstring uri

The URL of the private registry.

usernamestring nullable

The username to use when authenticating with the private registry.

replaces_baseboolean

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.

visibility'all' | 'private' | 'selected' required

Which type of organization repositories have access to the private registry.

tenant_idstring

The tenant ID of the Azure AD application.

client_idstring

The client ID of the Azure AD application.

aws_regionstring

The AWS region.

account_idstring

The AWS account ID.

role_namestring

The AWS IAM role name.

domainstring

The CodeArtifact domain.

domain_ownerstring

The CodeArtifact domain owner.

jfrog_oidc_provider_namestring

The JFrog OIDC provider name.

audiencestring

The OIDC audience.

identity_mapping_namestring

The JFrog identity mapping name.

namespacestring

The Cloudsmith organization namespace.

service_slugstring

The Cloudsmith service account slug.

api_hoststring

The Cloudsmith API host.

workload_identity_providerstring

The full resource name of the GCP Workload Identity Provider (e.g. projects/<NUM>/locations/global/workloadIdentityPools/<POOL>/providers/<PROVIDER>).

service_accountstring

The GCP service account email to impersonate. If omitted, the federated token is used directly (direct WIF).

created_atstring date-time required
updated_atstring date-time required

Example response

{
  "name": "MAVEN_REPOSITORY_SECRET",
  "username": "monalisa"
}