List secrets for the authenticated user

GET

/user/codespaces/secrets

Lists all development environment secrets available for a user’s codespaces without revealing their encrypted values.

The authenticated user must have Codespaces access to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the codespace or codespace:secrets scope to use this endpoint.

API method documentation

Parameters

Query Parameters

per_page

integer

default: 30

The number of results per page (max 100). For more information, see “Using pagination in the REST API.”

page

integer

default: 1

The page number of the results to fetch. For more information, see “Using pagination in the REST API.”

Responses

200

Response

Media type application/json

object

total_count

required

integer

secrets

required

Array<object>

Codespaces Secret

Secrets for a GitHub Codespace.

object

name

required

The name of the secret

string

created_at

required

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

string format: date-time

updated_at

required

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

string format: date-time

visibility

required

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

string

Allowed values: all private selected

selected_repositories_url

required

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

string format: uri

Examples

Example default

{
  "total_count": 2,
  "secrets": [
    {
      "name": "GH_TOKEN",
      "created_at": "2019-08-10T14:59:22Z",
      "updated_at": "2020-01-10T14:59:22Z",
      "visibility": "all"
    },
    {
      "name": "GIST_ID",
      "created_at": "2020-01-10T10:59:22Z",
      "updated_at": "2020-01-11T11:59:22Z",
      "visibility": "all"
    }
  ]
}

Headers

Link

string

Example

<https://api.github.com/resource?page=2>; rel="next", <https://api.github.com/resource?page=5>; rel="last"