actions

Create or update an organization secret

Creates or updates an organization secret with an encrypted value. Encrypt your secret using LibSodium. For more information, see "Encrypting secrets for the REST API."

Authenticated users must have collaborator access to a repository to create, update, or read secrets.

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

put/orgs/{org}/actions/secrets/{secret_name}

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/orgs/{org}/actions/secrets/{secret_name}
  • Auth: none declared

Path parameters

orgstring required

The organization name. The name is not case sensitive.

secret_namestring required

The name of the secret.

Request body

encrypted_valuestring required

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

key_idstring required

ID of the key you used to encrypt the secret.

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

Which type of organization repositories have access to the organization secret. selected means only the repositories specified by selected_repository_ids can access the secret.

selected_repository_idsinteger[]

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

Response

Response when creating a secret

EmptyObject required

An object without any properties.

Changes

No recorded changes to this operation across all 83 revisions of this API.