Skip to main content
REST API теперь версия. Дополнительные сведения см. в разделе "О управлении версиями API".

Секреты организации codespaces

Use the REST API to manage your organization-level Codespaces secrets.

Примечание. Эти конечные точки в настоящее время находятся в общедоступной бета-версии и подвержены изменению.

List organization secrets

Lists all Codespaces secrets available at the organization-level without revealing their encrypted values. You must authenticate using an access token with the admin:org scope to use this endpoint.

Параметры для "List organization secrets"

Заголовки
Имя, Вид, Description
accept string

Setting to application/vnd.github+json is recommended.

Параметры пути
Имя, Вид, Description
org string Обязательное поле

The organization name. The name is not case sensitive.

Параметры запроса
Имя, Вид, Description
per_page integer

The number of results per page (max 100).

По умолчанию.: 30

page integer

Page number of the results to fetch.

По умолчанию.: 1

Коды состояния http-ответа для "List organization secrets"

Код состоянияDescription
200

OK

Примеры кода для "List organization secrets"

get/orgs/{org}/codespaces/secrets
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/codespaces/secrets

Response

Status: 200
{ "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" } ] }

Get an organization public key

Gets a public key for an organization, which is required in order to encrypt secrets. You need to encrypt the value of a secret before you can create or update secrets. You must authenticate using an access token with the admin:org scope to use this endpoint.

Параметры для "Get an organization public key"

Заголовки
Имя, Вид, Description
accept string

Setting to application/vnd.github+json is recommended.

Параметры пути
Имя, Вид, Description
org string Обязательное поле

The organization name. The name is not case sensitive.

Коды состояния http-ответа для "Get an organization public key"

Код состоянияDescription
200

OK

Примеры кода для "Get an organization public key"

get/orgs/{org}/codespaces/secrets/public-key
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/codespaces/secrets/public-key

Response

Status: 200
{ "key_id": "012345678912345678", "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" }

Get an organization secret

Gets an organization secret without revealing its encrypted value. You must authenticate using an access token with the admin:org scope to use this endpoint.

Параметры для "Get an organization secret"

Заголовки
Имя, Вид, Description
accept string

Setting to application/vnd.github+json is recommended.

Параметры пути
Имя, Вид, Description
org string Обязательное поле

The organization name. The name is not case sensitive.

secret_name string Обязательное поле

The name of the secret.

Коды состояния http-ответа для "Get an organization secret"

Код состоянияDescription
200

OK

Примеры кода для "Get an organization secret"

get/orgs/{org}/codespaces/secrets/{secret_name}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/codespaces/secrets/SECRET_NAME

Response

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

Create or update an organization secret

Creates or updates an organization secret with an encrypted value. Encrypt your secret using LibSodium. For more information, see "Encrypting secrets for the REST API."

You must authenticate using an access token with the admin:org scope to use this endpoint.

Параметры для "Create or update an organization secret"

Заголовки
Имя, Вид, Description
accept string

Setting to application/vnd.github+json is recommended.

Параметры пути
Имя, Вид, Description
org string Обязательное поле

The organization name. The name is not case sensitive.

secret_name string Обязательное поле

The name of the secret.

Параметры запроса
Имя, Вид, Description
encrypted_value string

The value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

key_id string

The ID of the key you used to encrypt the secret.

visibility string Обязательное поле

Which type of organization repositories have access to the organization secret. selected means only the repositories specified by selected_repository_ids can access the secret.

Возможные значения: all, private, selected

selected_repository_ids array of integers

An array of repository IDs that can access the organization secret. You can only provide a list of repository IDs when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

Коды состояния http-ответа для "Create or update an organization secret"

Код состоянияDescription
201

Response when creating a secret

204

Response when updating a secret

404

Resource not found

422

Validation failed, or the endpoint has been spammed.

Примеры кода для "Create or update an organization secret"

put/orgs/{org}/codespaces/secrets/{secret_name}
curl -L \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/codespaces/secrets/SECRET_NAME \ -d '{"encrypted_value":"c2VjcmV0","key_id":"012345678912345678","visibility":"selected","selected_repository_ids":[1296269,1296280]}'

Response when creating a secret

Delete an organization secret

Deletes an organization secret using the secret name. You must authenticate using an access token with the admin:org scope to use this endpoint.

Параметры для "Delete an organization secret"

Заголовки
Имя, Вид, Description
accept string

Setting to application/vnd.github+json is recommended.

Параметры пути
Имя, Вид, Description
org string Обязательное поле

The organization name. The name is not case sensitive.

secret_name string Обязательное поле

The name of the secret.

Коды состояния http-ответа для "Delete an organization secret"

Код состоянияDescription
204

No Content

404

Resource not found

Примеры кода для "Delete an organization secret"

delete/orgs/{org}/codespaces/secrets/{secret_name}
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/codespaces/secrets/SECRET_NAME

Response

Status: 204

List selected repositories for an organization secret

Lists all repositories that have been selected when the visibility for repository access to a secret is set to selected. You must authenticate using an access token with the admin:org scope to use this endpoint.

Параметры для "List selected repositories for an organization secret"

Заголовки
Имя, Вид, Description
accept string

Setting to application/vnd.github+json is recommended.

Параметры пути
Имя, Вид, Description
org string Обязательное поле

The organization name. The name is not case sensitive.

secret_name string Обязательное поле

The name of the secret.

Параметры запроса
Имя, Вид, Description
page integer

Page number of the results to fetch.

По умолчанию.: 1

per_page integer

The number of results per page (max 100).

По умолчанию.: 30

Коды состояния http-ответа для "List selected repositories for an organization secret"

Код состоянияDescription
200

OK

404

Resource not found

Примеры кода для "List selected repositories for an organization secret"

get/orgs/{org}/codespaces/secrets/{secret_name}/repositories
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/codespaces/secrets/SECRET_NAME/repositories

Response

Status: 200
{ "total_count": 1, "repositories": [ { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", "followers_url": "https://api.github.com/users/octocat/followers", "following_url": "https://api.github.com/users/octocat/following{/other_user}", "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", "organizations_url": "https://api.github.com/users/octocat/orgs", "repos_url": "https://api.github.com/users/octocat/repos", "events_url": "https://api.github.com/users/octocat/events{/privacy}", "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api.github.com/repos/octocat/Hello-World", "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", "events_url": "https://api.github.com/repos/octocat/Hello-World/events", "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:github.com/octocat/Hello-World.git", "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "git@github.com:octocat/Hello-World.git", "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" } ] }

Set selected repositories for an organization secret

Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint.

Параметры для "Set selected repositories for an organization secret"

Заголовки
Имя, Вид, Description
accept string

Setting to application/vnd.github+json is recommended.

Параметры пути
Имя, Вид, Description
org string Обязательное поле

The organization name. The name is not case sensitive.

secret_name string Обязательное поле

The name of the secret.

Параметры запроса
Имя, Вид, Description
selected_repository_ids array of integers Обязательное поле

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

Коды состояния http-ответа для "Set selected repositories for an organization secret"

Код состоянияDescription
204

No Content

404

Resource not found

409

Conflict when visibility type not set to selected

Примеры кода для "Set selected repositories for an organization secret"

put/orgs/{org}/codespaces/secrets/{secret_name}/repositories
curl -L \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/codespaces/secrets/SECRET_NAME/repositories \ -d '{"selected_repository_ids":[64780797]}'

Response

Status: 204

Add selected repository to an organization secret

Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint.

Параметры для "Add selected repository to an organization secret"

Заголовки
Имя, Вид, Description
accept string

Setting to application/vnd.github+json is recommended.

Параметры пути
Имя, Вид, Description
org string Обязательное поле

The organization name. The name is not case sensitive.

secret_name string Обязательное поле

The name of the secret.

repository_id integer Обязательное поле

Коды состояния http-ответа для "Add selected repository to an organization secret"

Код состоянияDescription
204

No Content when repository was added to the selected list

404

Resource not found

409

Conflict when visibility type is not set to selected

422

Validation failed, or the endpoint has been spammed.

Примеры кода для "Add selected repository to an organization secret"

put/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}
curl -L \ -X PUT \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/codespaces/secrets/SECRET_NAME/repositories/REPOSITORY_ID

No Content when repository was added to the selected list

Status: 204

Remove selected repository from an organization secret

Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint.

Параметры для "Remove selected repository from an organization secret"

Заголовки
Имя, Вид, Description
accept string

Setting to application/vnd.github+json is recommended.

Параметры пути
Имя, Вид, Description
org string Обязательное поле

The organization name. The name is not case sensitive.

secret_name string Обязательное поле

The name of the secret.

repository_id integer Обязательное поле

Коды состояния http-ответа для "Remove selected repository from an organization secret"

Код состоянияDescription
204

Response when repository was removed from the selected list

404

Resource not found

409

Conflict when visibility type not set to selected

422

Validation failed, or the endpoint has been spammed.

Примеры кода для "Remove selected repository from an organization secret"

delete/orgs/{org}/codespaces/secrets/{secret_name}/repositories/{repository_id}
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/orgs/ORG/codespaces/secrets/SECRET_NAME/repositories/REPOSITORY_ID

Response when repository was removed from the selected list

Status: 204