Get public key for the authenticated user

GET

/user/codespaces/secrets/public-key

Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.

You must authenticate using an access token with the codespace or codespace:secrets scope to use this endpoint. User must have Codespaces access to use this endpoint.

GitHub Apps must have read access to the codespaces_user_secrets user permission to use this endpoint.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.github.com/user/codespaces/secrets/public-key'

Response Example

{
    "key": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=",
    "key_id": "1234567"
}

Request

None

Responses

🟢200Response

application/json

Body

The public key used for setting user Codespaces' Secrets.

key

string

required

The Base64 encoded public key.

Example:

hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=

key_id

string

required

The identifier for the key.

Example:

1234567

Modified at 2023-08-15 02:59:24

List secrets for the authenticated user

Delete a secret for the authenticated user