apicheats.dev Cheat sheet Raw .md
PATCH

Try PATCH /orgs/{org}/private-registries/{secret_name} — GitHub API

GitHub playground

Update a private registry for an organization

Credentials

Kept in this tab only. Requests go through apicheats.dev's same-origin proxy straight to api.github.com; the proxy stores and logs nothing about them.

Headers

Path

Body application/json

24 body fields
  • registry_type · optional · string — The registry type.
  • url · optional · string — The URL of the private registry.
  • username · optional · string — The username to use when authenticating with the private registry. This field should be omitted if the private registry does not require a username for authentication.
  • replaces_base · optional · boolean — Whether this private registry should replace the base registry (e.g., npmjs.org for npm, rubygems.org for rubygems). When set to `true`, Dependabot will only use this registry and will not fall back to the public registry. When set to `false` (default), Dependabot will use this registry for scoped packages but may fall back to the public registry for other packages.
  • encrypted_value · optional · string — The value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get private registries public key for an organization](https://docs.github.com/rest/private-registries/organization-configurations#get-private-registries-public-key-for-an-organization) endpoint.
  • key_id · optional · string — The ID of the key you used to encrypt the secret.
  • visibility · optional · string — Which type of organization repositories have access to the private registry. `selected` means only the repositories specified by `selected_repository_ids` can access the private registry.
  • selected_repository_ids · optional · integer[] — An array of repository IDs that can access the organization private registry. You can only provide a list of repository IDs when `visibility` is set to `selected`. This field should be omitted if `visibility` is set to `all` or `private`.
  • auth_type · optional · string — The authentication type for the private registry. This field cannot be changed after creation. If provided, it must match the existing `auth_type` of the configuration. To change the authentication type, delete and recreate the configuration.
  • tenant_id · optional · string — The tenant ID of the Azure AD application. Required when `auth_type` is `oidc_azure`.
  • client_id · optional · string — The client ID of the Azure AD application. Required when `auth_type` is `oidc_azure`.
  • aws_region · optional · string — The AWS region. Required when `auth_type` is `oidc_aws`.
  • account_id · optional · string — The AWS account ID. Required when `auth_type` is `oidc_aws`.
  • role_name · optional · string — The AWS IAM role name. Required when `auth_type` is `oidc_aws`.
  • domain · optional · string — The CodeArtifact domain. Required when `auth_type` is `oidc_aws`.
  • domain_owner · optional · string — The CodeArtifact domain owner (AWS account ID). Required when `auth_type` is `oidc_aws`.
  • jfrog_oidc_provider_name · optional · string — The JFrog OIDC provider name. Required when `auth_type` is `oidc_jfrog`.
  • audience · optional · string — The OIDC audience. Optional for `oidc_aws`, `oidc_jfrog`, and `oidc_gcp`, and required for `oidc_cloudsmith` auth types.
  • identity_mapping_name · optional · string — The JFrog identity mapping name. Optional for `oidc_jfrog` auth type.
  • namespace · optional · string — The Cloudsmith organization namespace. Required when `auth_type` is `oidc_cloudsmith`.
  • service_slug · optional · string — The Cloudsmith service account slug. Required when `auth_type` is `oidc_cloudsmith`.
  • api_host · optional · string — The Cloudsmith API host. Optional for `oidc_cloudsmith` auth type. If omitted, `api.cloudsmith.io` is used by default.
  • workload_identity_provider · optional · string — The full resource name of the GCP Workload Identity Provider (e.g. `projects/<NUM>/locations/global/workloadIdentityPools/<POOL>/providers/<PROVIDER>`). Required when `auth_type` is `oidc_gcp`.
  • service_account · optional · string — The GCP service account email to impersonate. Optional for `oidc_gcp` auth type. If omitted, the federated token is used directly (direct WIF).