Get an environment secret

GET

/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}

Gets a single environment secret without revealing its encrypted value.

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.

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.

environment_name

required

string

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

secret_name

required

string

The name of the secret.

Responses

200

Response

Media type application/json

Actions Secret

Set secrets for GitHub Actions.

object

name

required

The name of the secret.

string

created_at

required

string format: date-time

updated_at

required

string format: date-time

Examples

Example default

{
  "name": "GH_TOKEN",
  "created_at": "2019-08-10T14:59:22Z",
  "updated_at": "2020-01-10T14:59:22Z"
}