List secrets for the authenticated user

GET

/user/codespaces/secrets

Lists all secrets available for a user's Codespaces without revealing their
encrypted values.

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'

Response Example

{
    "secrets": [
        {
            "created_at": "2019-08-24T14:15:22Z",
            "name": "SECRET_NAME",
            "selected_repositories_url": "https://api.github.com/user/secrets/SECRET_NAME/repositories",
            "updated_at": "2019-08-24T14:15:22Z",
            "visibility": "all"
        }
    ],
    "total_count": 0
}

Request

Query Params

per_page

integer

optional

The number of results per page (max 100).

page

integer

optional

Page number of the results to fetch.

Responses

🟢200Response

application/json

Body

secrets

array[object (Codespaces Secret) {5}]

required

created_at

string <date-time>

required

The date and time at which the secret was created, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.

name

string

required

The name of the secret

Example:

SECRET_NAME

selected_repositories_url

string <uri>

required

The API URL at which the list of repositories this secret is visible to can be retrieved

Example:

https://api.github.com/user/secrets/SECRET_NAME/repositories

updated_at

string <date-time>

required

The date and time at which the secret was last updated, in ISO 8601 format':' YYYY-MM-DDTHH:MM:SSZ.

visibility

enum<string>

required

The type of repositories in the organization that the secret is visible to

Allowed values:

allprivateselected

total_count

integer

required

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

Create a codespace for the authenticated user

Get public key for the authenticated user