Search + K

Command Palette

Search for a command to run...

Sign In

Create or update an environment secret

PUT /repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}
Copy endpoint
https://api.github.com

Creates or updates an environment 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 the repo scope to use this endpoint.

Parameters

path Path Parameters

Name Type
owner required

The account owner of the repository. The name is not case sensitive.

string
repo required

The name of the repository without the .git extension. The name is not case sensitive.

string
environment_name required

The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with %2F.

string
secret_name required

The name of the secret.

string

Request Body

application/json required
{ encrypted_value: string;key_id: string; }

Responses

201 application/json

Response when creating a secret

interface EmptyObject {}
204

Response when updating a secret

unknown