Create or update a repository secret

PUT

/repos/{owner}/{repo}/codespaces/secrets/{secret_name}

Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using LibSodium. For more information, see “Encrypting secrets for the REST API.”

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint. The associated user must be a repository admin.

API method documentation

Parameters

Path Parameters

owner

required

string

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

repo

required

string

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

secret_name

required

string

The name of the secret.

Request Body ^required

Media type application/json

object

encrypted_value

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

string

/^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$/

key_id

ID of the key you used to encrypt the secret.

string

Examples

Example default

{
  "encrypted_value": "c2VjcmV0",
  "key_id": "012345678912345678"
}

Responses

201

Response when creating a secret

Media type application/json

Empty Object

An object without any properties.

object

Examples

Example default

null

204

Response when updating a secret