Get an organization secret

Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.

GET/orgs/{org}/actions/secrets/{secret_name}

Source: github-v3-rest.json
Revision: f5f067c1e6f6
Active snapshot: 85e53e3d0d65

Request

Path Parameters

org string required
secret_name string required: secret_name parameter

Responses

application/json Actions Secret for an Organization object

Response

created_at string<date-time>

required

name string

required

The name of the secret.

Example: SECRET_TOKEN

selected_repositories_url string<uri>

optional

Example: https://api.github.com/organizations/org/secrets/my_secret/repositories

updated_at string<date-time>

required

visibility string

required

Visibility of a secret

Allowed: "all""private""selected"

Response Example: 200 application/json

{
  "created_at": "2019-08-10T14:59:22Z",
  "name": "GH_TOKEN",
  "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories",
  "updated_at": "2020-01-10T14:59:22Z",
  "visibility": "selected"
}

Request configuration

This OpenAPI document does not declare an authentication scheme. Check the API provider's documentation before sending credentials; Manja cannot infer or validate an undocumented scheme.

Common bearer example: Authorization: Bearer YOUR_ACCESS_TOKEN

hostname

Self-hosted Enterprise Server or Enterprise Cloud hostname

protocol

Self-hosted Enterprise Server or Enterprise Cloud protocol

org *

secret_name *

secret_name parameter

Request Sample: Shell / cURL

curl --request GET \
  --url {protocol}://{hostname}/api/v3/orgs/{org}/actions/secrets/{secret_name}