Pontos de extremidade da API REST para organizações do Codespaces

Lists the codespaces associated to a specified organization.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

Tokens de acesso refinados para "List codespaces for the organization"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Codespaces" repository permissions (read) and "Organization codespaces" organization permissions (read)

Parâmetros para "List codespaces for the organization"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.

Parâmetros de consulta
Nome, Tipo, Descrição
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Padrão: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Padrão: `1`

Códigos de status de resposta HTTP para "List codespaces for the organization"

Código de status	Descrição
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`500`	Internal Error

Exemplos de código para "List codespaces for the organization"

Exemplo de solicitação

get/orgs/{org}/codespaces

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

Response

Status: 200

{ "total_count": 3, "codespaces": [ { "id": 1, "name": "monalisa-octocat-hello-world-g4wpq6h95q", "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api..com/users/octocat", "html_url": "https://.com/octocat", "followers_url": "https://api..com/users/octocat/followers", "following_url": "https://api..com/users/octocat/following{/other_user}", "gists_url": "https://api..com/users/octocat/gists{/gist_id}", "starred_url": "https://api..com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api..com/users/octocat/subscriptions", "organizations_url": "https://api..com/users/octocat/orgs", "repos_url": "https://api..com/users/octocat/repos", "events_url": "https://api..com/users/octocat/events{/privacy}", "received_events_url": "https://api..com/users/octocat/received_events", "type": "User", "site_admin": false }, "billable_owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api..com/users/octocat", "html_url": "https://.com/octocat", "followers_url": "https://api..com/users/octocat/followers", "following_url": "https://api..com/users/octocat/following{/other_user}", "gists_url": "https://api..com/users/octocat/gists{/gist_id}", "starred_url": "https://api..com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api..com/users/octocat/subscriptions", "organizations_url": "https://api..com/users/octocat/orgs", "repos_url": "https://api..com/users/octocat/repos", "events_url": "https://api..com/users/octocat/events{/privacy}", "received_events_url": "https://api..com/users/octocat/received_events", "type": "User", "site_admin": false }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api..com/users/octocat", "html_url": "https://.com/octocat", "followers_url": "https://api..com/users/octocat/followers", "following_url": "https://api..com/users/octocat/following{/other_user}", "gists_url": "https://api..com/users/octocat/gists{/gist_id}", "starred_url": "https://api..com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api..com/users/octocat/subscriptions", "organizations_url": "https://api..com/users/octocat/orgs", "repos_url": "https://api..com/users/octocat/repos", "events_url": "https://api..com/users/octocat/events{/privacy}", "received_events_url": "https://api..com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api..com/repos/octocat/Hello-World", "archive_url": "https://api..com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api..com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api..com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api..com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api..com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api..com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api..com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api..com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api..com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api..com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api..com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api..com/repos/octocat/Hello-World/downloads", "events_url": "https://api..com/repos/octocat/Hello-World/events", "forks_url": "https://api..com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api..com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api..com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api..com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:.com/octocat/Hello-World.git", "issue_comment_url": "https://api..com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api..com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api..com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api..com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api..com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api..com/repos/octocat/Hello-World/languages", "merges_url": "https://api..com/repos/octocat/Hello-World/merges", "milestones_url": "https://api..com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api..com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api..com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api..com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "[email protected]:octocat/Hello-World.git", "stargazers_url": "https://api..com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api..com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api..com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api..com/repos/octocat/Hello-World/subscription", "tags_url": "https://api..com/repos/octocat/Hello-World/tags", "teams_url": "https://api..com/repos/octocat/Hello-World/teams", "trees_url": "https://api..com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api..com/repos/octocat/Hello-World/hooks" }, "machine": { "name": "standardLinux", "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, "devcontainer_path": ".devcontainer/devcontainer.json", "created_at": "2021-10-14T00:53:30-06:00", "updated_at": "2021-10-14T00:53:32-06:00", "last_used_at": "2021-10-14T00:53:30-06:00", "state": "Available", "url": "https://api..com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", "git_status": { "ahead": 0, "behind": 0, "has_unpushed_changes": false, "has_uncommitted_changes": false, "ref": "main" }, "location": "WestUs2", "idle_timeout_minutes": 60, "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q..dev", "machines_url": "https://api..com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", "start_url": "https://api..com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", "stop_url": "https://api..com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", "recent_folders": [] }, { "id": 1, "name": "monalisa-octocat-hello-world-3f89ada1j3", "environment_id": "526ce4d7-46da-494f-a4f9-cfd25b818719", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api..com/users/octocat", "html_url": "https://.com/octocat", "followers_url": "https://api..com/users/octocat/followers", "following_url": "https://api..com/users/octocat/following{/other_user}", "gists_url": "https://api..com/users/octocat/gists{/gist_id}", "starred_url": "https://api..com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api..com/users/octocat/subscriptions", "organizations_url": "https://api..com/users/octocat/orgs", "repos_url": "https://api..com/users/octocat/repos", "events_url": "https://api..com/users/octocat/events{/privacy}", "received_events_url": "https://api..com/users/octocat/received_events", "type": "User", "site_admin": false }, "billable_owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api..com/users/octocat", "html_url": "https://.com/octocat", "followers_url": "https://api..com/users/octocat/followers", "following_url": "https://api..com/users/octocat/following{/other_user}", "gists_url": "https://api..com/users/octocat/gists{/gist_id}", "starred_url": "https://api..com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api..com/users/octocat/subscriptions", "organizations_url": "https://api..com/users/octocat/orgs", "repos_url": "https://api..com/users/octocat/repos", "events_url": "https://api..com/users/octocat/events{/privacy}", "received_events_url": "https://api..com/users/octocat/received_events", "type": "User", "site_admin": false }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api..com/users/octocat", "html_url": "https://.com/octocat", "followers_url": "https://api..com/users/octocat/followers", "following_url": "https://api..com/users/octocat/following{/other_user}", "gists_url": "https://api..com/users/octocat/gists{/gist_id}", "starred_url": "https://api..com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api..com/users/octocat/subscriptions", "organizations_url": "https://api..com/users/octocat/orgs", "repos_url": "https://api..com/users/octocat/repos", "events_url": "https://api..com/users/octocat/events{/privacy}", "received_events_url": "https://api..com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api..com/repos/octocat/Hello-World", "archive_url": "https://api..com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api..com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api..com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api..com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api..com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api..com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api..com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api..com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api..com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api..com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api..com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api..com/repos/octocat/Hello-World/downloads", "events_url": "https://api..com/repos/octocat/Hello-World/events", "forks_url": "https://api..com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api..com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api..com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api..com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:.com/octocat/Hello-World.git", "issue_comment_url": "https://api..com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api..com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api..com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api..com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api..com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api..com/repos/octocat/Hello-World/languages", "merges_url": "https://api..com/repos/octocat/Hello-World/merges", "milestones_url": "https://api..com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api..com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api..com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api..com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "[email protected]:octocat/Hello-World.git", "stargazers_url": "https://api..com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api..com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api..com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api..com/repos/octocat/Hello-World/subscription", "tags_url": "https://api..com/repos/octocat/Hello-World/tags", "teams_url": "https://api..com/repos/octocat/Hello-World/teams", "trees_url": "https://api..com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api..com/repos/octocat/Hello-World/hooks" }, "machine": { "name": "standardLinux", "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, "devcontainer_path": ".devcontainer/foobar/devcontainer.json", "created_at": "2021-10-14T00:53:30-06:00", "updated_at": "2021-10-14T00:53:32-06:00", "last_used_at": "2021-10-14T00:53:30-06:00", "state": "Available", "url": "https://api..com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3", "git_status": { "ahead": 0, "behind": 0, "has_unpushed_changes": false, "has_uncommitted_changes": false, "ref": "main" }, "location": "WestUs2", "idle_timeout_minutes": 60, "web_url": "https://monalisa-octocat-hello-world-3f89ada1j3..dev", "machines_url": "https://api..com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines", "start_url": "https://api..com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start", "stop_url": "https://api..com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop", "recent_folders": [] }, { "id": 1, "name": "monalisa-octocat-hello-world-f8adfad99a", "environment_id": "6ac8cd6d-a2d0-4ae3-8cea-e135059264df", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api..com/users/octocat", "html_url": "https://.com/octocat", "followers_url": "https://api..com/users/octocat/followers", "following_url": "https://api..com/users/octocat/following{/other_user}", "gists_url": "https://api..com/users/octocat/gists{/gist_id}", "starred_url": "https://api..com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api..com/users/octocat/subscriptions", "organizations_url": "https://api..com/users/octocat/orgs", "repos_url": "https://api..com/users/octocat/repos", "events_url": "https://api..com/users/octocat/events{/privacy}", "received_events_url": "https://api..com/users/octocat/received_events", "type": "User", "site_admin": false }, "billable_owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api..com/users/octocat", "html_url": "https://.com/octocat", "followers_url": "https://api..com/users/octocat/followers", "following_url": "https://api..com/users/octocat/following{/other_user}", "gists_url": "https://api..com/users/octocat/gists{/gist_id}", "starred_url": "https://api..com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api..com/users/octocat/subscriptions", "organizations_url": "https://api..com/users/octocat/orgs", "repos_url": "https://api..com/users/octocat/repos", "events_url": "https://api..com/users/octocat/events{/privacy}", "received_events_url": "https://api..com/users/octocat/received_events", "type": "User", "site_admin": false }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api..com/users/octocat", "html_url": "https://.com/octocat", "followers_url": "https://api..com/users/octocat/followers", "following_url": "https://api..com/users/octocat/following{/other_user}", "gists_url": "https://api..com/users/octocat/gists{/gist_id}", "starred_url": "https://api..com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api..com/users/octocat/subscriptions", "organizations_url": "https://api..com/users/octocat/orgs", "repos_url": "https://api..com/users/octocat/repos", "events_url": "https://api..com/users/octocat/events{/privacy}", "received_events_url": "https://api..com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api..com/repos/octocat/Hello-World", "archive_url": "https://api..com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api..com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api..com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api..com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api..com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api..com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api..com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api..com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api..com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api..com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api..com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api..com/repos/octocat/Hello-World/downloads", "events_url": "https://api..com/repos/octocat/Hello-World/events", "forks_url": "https://api..com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api..com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api..com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api..com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:.com/octocat/Hello-World.git", "issue_comment_url": "https://api..com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api..com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api..com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api..com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api..com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api..com/repos/octocat/Hello-World/languages", "merges_url": "https://api..com/repos/octocat/Hello-World/merges", "milestones_url": "https://api..com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api..com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api..com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api..com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "[email protected]:octocat/Hello-World.git", "stargazers_url": "https://api..com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api..com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api..com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api..com/repos/octocat/Hello-World/subscription", "tags_url": "https://api..com/repos/octocat/Hello-World/tags", "teams_url": "https://api..com/repos/octocat/Hello-World/teams", "trees_url": "https://api..com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api..com/repos/octocat/Hello-World/hooks" }, "machine": { "name": "standardLinux", "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, "devcontainer_path": ".devcontainer.json", "created_at": "2021-10-14T00:53:30-06:00", "updated_at": "2021-10-14T00:53:32-06:00", "last_used_at": "2021-10-14T00:53:30-06:00", "state": "Available", "url": "https://api..com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a", "git_status": { "ahead": 0, "behind": 0, "has_unpushed_changes": false, "has_uncommitted_changes": false, "ref": "main" }, "location": "WestUs2", "idle_timeout_minutes": 60, "web_url": "https://monalisa-octocat-hello-world-f8adfad99a..dev", "machines_url": "https://api..com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines", "start_url": "https://api..com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start", "stop_url": "https://api..com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop", "recent_folders": [] } ] }

Sets which users can access codespaces in an organization. This is synonymous with granting or revoking codespaces access permissions for users according to the visibility. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

Tokens de acesso refinados para "Manage access control for organization codespaces"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Organization codespaces settings" organization permissions (write)

Parâmetros para "Manage access control for organization codespaces"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.

Parâmetros do corpo
Nome, Tipo, Descrição
`visibility` string Obrigatório Which users can access codespaces in the organization. `disabled` means that no users can access codespaces in the organization. Pode ser um dos: `disabled`, `selected_members`, `all_members`, `all_members_and_outside_collaborators`
`selected_usernames` array of strings The usernames of the organization members who should have access to codespaces in the organization. Required when `visibility` is `selected_members`. The provided list of usernames will replace any existing value.

Códigos de status de resposta HTTP para "Manage access control for organization codespaces"

Código de status	Descrição
`204`	Response when successfully modifying permissions.
`304`	Not modified
`400`	Users are neither members nor collaborators of this organization.
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.
`500`	Internal Error

Exemplos de código para "Manage access control for organization codespaces"

Exemplo de solicitação

put/orgs/{org}/codespaces/access

curl -L \ -X PUT \ -H "Accept: application/vnd.+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X--Api-Version: 2022-11-28" \ https://api..com/orgs/ORG/codespaces/access \ -d '{"visibility":"selected_members","selected_usernames":["johnDoe","atomIO"]}'

Response when successfully modifying permissions.

Status: 204

Codespaces for the specified users will be billed to the organization.

To use this endpoint, the access settings for the organization must be set to selected_members. For information on how to change this setting, see "Manage access control for organization codespaces."

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

Tokens de acesso refinados para "Add users to Codespaces access for an organization"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Organization codespaces settings" organization permissions (write)

Parâmetros para "Add users to Codespaces access for an organization"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.

Parâmetros do corpo
Nome, Tipo, Descrição
`selected_usernames` array of strings Obrigatório The usernames of the organization members whose codespaces be billed to the organization.

Códigos de status de resposta HTTP para "Add users to Codespaces access for an organization"

Código de status	Descrição
`204`	Response when successfully modifying permissions.
`304`	Not modified
`400`	Users are neither members nor collaborators of this organization.
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.
`500`	Internal Error

Exemplos de código para "Add users to Codespaces access for an organization"

Exemplo de solicitação

post/orgs/{org}/codespaces/access/selected_users

curl -L \ -X POST \ -H "Accept: application/vnd.+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X--Api-Version: 2022-11-28" \ https://api..com/orgs/ORG/codespaces/access/selected_users \ -d '{"selected_usernames":["johnDoe","atomIO"]}'

Response when successfully modifying permissions.

Status: 204

Codespaces for the specified users will no longer be billed to the organization.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

Tokens de acesso refinados para "Remove users from Codespaces access for an organization"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Organization codespaces settings" organization permissions (write)

Parâmetros para "Remove users from Codespaces access for an organization"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.

Parâmetros do corpo
Nome, Tipo, Descrição
`selected_usernames` array of strings Obrigatório The usernames of the organization members whose codespaces should not be billed to the organization.

Códigos de status de resposta HTTP para "Remove users from Codespaces access for an organization"

Código de status	Descrição
`204`	Response when successfully modifying permissions.
`304`	Not modified
`400`	Users are neither members nor collaborators of this organization.
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.
`500`	Internal Error

Exemplos de código para "Remove users from Codespaces access for an organization"

Exemplo de solicitação

delete/orgs/{org}/codespaces/access/selected_users

curl -L \ -X DELETE \ -H "Accept: application/vnd.+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X--Api-Version: 2022-11-28" \ https://api..com/orgs/ORG/codespaces/access/selected_users \ -d '{"selected_usernames":["johnDoe","atomIO"]}'

Response when successfully modifying permissions.

Status: 204

Lists the codespaces that a member of an organization has for repositories in that organization.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

Tokens de acesso refinados para "List codespaces for a user in organization"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Codespaces" repository permissions (read) and "Organization codespaces" organization permissions (read)

Parâmetros para "List codespaces for a user in organization"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.
`username` string Obrigatório The handle for the user account.

Parâmetros de consulta
Nome, Tipo, Descrição
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Padrão: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Padrão: `1`

Códigos de status de resposta HTTP para "List codespaces for a user in organization"

Código de status	Descrição
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`500`	Internal Error

Exemplos de código para "List codespaces for a user in organization"

Exemplo de solicitação

get/orgs/{org}/members/{username}/codespaces

curl -L \ -H "Accept: application/vnd.+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X--Api-Version: 2022-11-28" \ https://api..com/orgs/ORG/members/USERNAME/codespaces

Response

Status: 200

{ "total_count": 3, "codespaces": [ { "id": 1, "name": "monalisa-octocat-hello-world-g4wpq6h95q", "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api..com/users/octocat", "html_url": "https://.com/octocat", "followers_url": "https://api..com/users/octocat/followers", "following_url": "https://api..com/users/octocat/following{/other_user}", "gists_url": "https://api..com/users/octocat/gists{/gist_id}", "starred_url": "https://api..com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api..com/users/octocat/subscriptions", "organizations_url": "https://api..com/users/octocat/orgs", "repos_url": "https://api..com/users/octocat/repos", "events_url": "https://api..com/users/octocat/events{/privacy}", "received_events_url": "https://api..com/users/octocat/received_events", "type": "User", "site_admin": false }, "billable_owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api..com/users/octocat", "html_url": "https://.com/octocat", "followers_url": "https://api..com/users/octocat/followers", "following_url": "https://api..com/users/octocat/following{/other_user}", "gists_url": "https://api..com/users/octocat/gists{/gist_id}", "starred_url": "https://api..com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api..com/users/octocat/subscriptions", "organizations_url": "https://api..com/users/octocat/orgs", "repos_url": "https://api..com/users/octocat/repos", "events_url": "https://api..com/users/octocat/events{/privacy}", "received_events_url": "https://api..com/users/octocat/received_events", "type": "User", "site_admin": false }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api..com/users/octocat", "html_url": "https://.com/octocat", "followers_url": "https://api..com/users/octocat/followers", "following_url": "https://api..com/users/octocat/following{/other_user}", "gists_url": "https://api..com/users/octocat/gists{/gist_id}", "starred_url": "https://api..com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api..com/users/octocat/subscriptions", "organizations_url": "https://api..com/users/octocat/orgs", "repos_url": "https://api..com/users/octocat/repos", "events_url": "https://api..com/users/octocat/events{/privacy}", "received_events_url": "https://api..com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api..com/repos/octocat/Hello-World", "archive_url": "https://api..com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api..com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api..com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api..com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api..com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api..com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api..com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api..com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api..com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api..com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api..com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api..com/repos/octocat/Hello-World/downloads", "events_url": "https://api..com/repos/octocat/Hello-World/events", "forks_url": "https://api..com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api..com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api..com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api..com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:.com/octocat/Hello-World.git", "issue_comment_url": "https://api..com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api..com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api..com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api..com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api..com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api..com/repos/octocat/Hello-World/languages", "merges_url": "https://api..com/repos/octocat/Hello-World/merges", "milestones_url": "https://api..com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api..com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api..com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api..com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "[email protected]:octocat/Hello-World.git", "stargazers_url": "https://api..com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api..com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api..com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api..com/repos/octocat/Hello-World/subscription", "tags_url": "https://api..com/repos/octocat/Hello-World/tags", "teams_url": "https://api..com/repos/octocat/Hello-World/teams", "trees_url": "https://api..com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api..com/repos/octocat/Hello-World/hooks" }, "machine": { "name": "standardLinux", "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, "devcontainer_path": ".devcontainer/devcontainer.json", "created_at": "2021-10-14T00:53:30-06:00", "updated_at": "2021-10-14T00:53:32-06:00", "last_used_at": "2021-10-14T00:53:30-06:00", "state": "Available", "url": "https://api..com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", "git_status": { "ahead": 0, "behind": 0, "has_unpushed_changes": false, "has_uncommitted_changes": false, "ref": "main" }, "location": "WestUs2", "idle_timeout_minutes": 60, "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q..dev", "machines_url": "https://api..com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", "start_url": "https://api..com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", "stop_url": "https://api..com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", "recent_folders": [] }, { "id": 1, "name": "monalisa-octocat-hello-world-3f89ada1j3", "environment_id": "526ce4d7-46da-494f-a4f9-cfd25b818719", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api..com/users/octocat", "html_url": "https://.com/octocat", "followers_url": "https://api..com/users/octocat/followers", "following_url": "https://api..com/users/octocat/following{/other_user}", "gists_url": "https://api..com/users/octocat/gists{/gist_id}", "starred_url": "https://api..com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api..com/users/octocat/subscriptions", "organizations_url": "https://api..com/users/octocat/orgs", "repos_url": "https://api..com/users/octocat/repos", "events_url": "https://api..com/users/octocat/events{/privacy}", "received_events_url": "https://api..com/users/octocat/received_events", "type": "User", "site_admin": false }, "billable_owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api..com/users/octocat", "html_url": "https://.com/octocat", "followers_url": "https://api..com/users/octocat/followers", "following_url": "https://api..com/users/octocat/following{/other_user}", "gists_url": "https://api..com/users/octocat/gists{/gist_id}", "starred_url": "https://api..com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api..com/users/octocat/subscriptions", "organizations_url": "https://api..com/users/octocat/orgs", "repos_url": "https://api..com/users/octocat/repos", "events_url": "https://api..com/users/octocat/events{/privacy}", "received_events_url": "https://api..com/users/octocat/received_events", "type": "User", "site_admin": false }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api..com/users/octocat", "html_url": "https://.com/octocat", "followers_url": "https://api..com/users/octocat/followers", "following_url": "https://api..com/users/octocat/following{/other_user}", "gists_url": "https://api..com/users/octocat/gists{/gist_id}", "starred_url": "https://api..com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api..com/users/octocat/subscriptions", "organizations_url": "https://api..com/users/octocat/orgs", "repos_url": "https://api..com/users/octocat/repos", "events_url": "https://api..com/users/octocat/events{/privacy}", "received_events_url": "https://api..com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api..com/repos/octocat/Hello-World", "archive_url": "https://api..com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api..com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api..com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api..com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api..com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api..com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api..com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api..com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api..com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api..com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api..com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api..com/repos/octocat/Hello-World/downloads", "events_url": "https://api..com/repos/octocat/Hello-World/events", "forks_url": "https://api..com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api..com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api..com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api..com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:.com/octocat/Hello-World.git", "issue_comment_url": "https://api..com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api..com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api..com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api..com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api..com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api..com/repos/octocat/Hello-World/languages", "merges_url": "https://api..com/repos/octocat/Hello-World/merges", "milestones_url": "https://api..com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api..com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api..com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api..com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "[email protected]:octocat/Hello-World.git", "stargazers_url": "https://api..com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api..com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api..com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api..com/repos/octocat/Hello-World/subscription", "tags_url": "https://api..com/repos/octocat/Hello-World/tags", "teams_url": "https://api..com/repos/octocat/Hello-World/teams", "trees_url": "https://api..com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api..com/repos/octocat/Hello-World/hooks" }, "machine": { "name": "standardLinux", "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, "devcontainer_path": ".devcontainer/foobar/devcontainer.json", "created_at": "2021-10-14T00:53:30-06:00", "updated_at": "2021-10-14T00:53:32-06:00", "last_used_at": "2021-10-14T00:53:30-06:00", "state": "Available", "url": "https://api..com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3", "git_status": { "ahead": 0, "behind": 0, "has_unpushed_changes": false, "has_uncommitted_changes": false, "ref": "main" }, "location": "WestUs2", "idle_timeout_minutes": 60, "web_url": "https://monalisa-octocat-hello-world-3f89ada1j3..dev", "machines_url": "https://api..com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/machines", "start_url": "https://api..com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/start", "stop_url": "https://api..com/user/codespaces/monalisa-octocat-hello-world-3f89ada1j3/stop", "recent_folders": [] }, { "id": 1, "name": "monalisa-octocat-hello-world-f8adfad99a", "environment_id": "6ac8cd6d-a2d0-4ae3-8cea-e135059264df", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api..com/users/octocat", "html_url": "https://.com/octocat", "followers_url": "https://api..com/users/octocat/followers", "following_url": "https://api..com/users/octocat/following{/other_user}", "gists_url": "https://api..com/users/octocat/gists{/gist_id}", "starred_url": "https://api..com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api..com/users/octocat/subscriptions", "organizations_url": "https://api..com/users/octocat/orgs", "repos_url": "https://api..com/users/octocat/repos", "events_url": "https://api..com/users/octocat/events{/privacy}", "received_events_url": "https://api..com/users/octocat/received_events", "type": "User", "site_admin": false }, "billable_owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api..com/users/octocat", "html_url": "https://.com/octocat", "followers_url": "https://api..com/users/octocat/followers", "following_url": "https://api..com/users/octocat/following{/other_user}", "gists_url": "https://api..com/users/octocat/gists{/gist_id}", "starred_url": "https://api..com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api..com/users/octocat/subscriptions", "organizations_url": "https://api..com/users/octocat/orgs", "repos_url": "https://api..com/users/octocat/repos", "events_url": "https://api..com/users/octocat/events{/privacy}", "received_events_url": "https://api..com/users/octocat/received_events", "type": "User", "site_admin": false }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api..com/users/octocat", "html_url": "https://.com/octocat", "followers_url": "https://api..com/users/octocat/followers", "following_url": "https://api..com/users/octocat/following{/other_user}", "gists_url": "https://api..com/users/octocat/gists{/gist_id}", "starred_url": "https://api..com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api..com/users/octocat/subscriptions", "organizations_url": "https://api..com/users/octocat/orgs", "repos_url": "https://api..com/users/octocat/repos", "events_url": "https://api..com/users/octocat/events{/privacy}", "received_events_url": "https://api..com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api..com/repos/octocat/Hello-World", "archive_url": "https://api..com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api..com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api..com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api..com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api..com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api..com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api..com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api..com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api..com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api..com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api..com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api..com/repos/octocat/Hello-World/downloads", "events_url": "https://api..com/repos/octocat/Hello-World/events", "forks_url": "https://api..com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api..com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api..com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api..com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:.com/octocat/Hello-World.git", "issue_comment_url": "https://api..com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api..com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api..com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api..com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api..com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api..com/repos/octocat/Hello-World/languages", "merges_url": "https://api..com/repos/octocat/Hello-World/merges", "milestones_url": "https://api..com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api..com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api..com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api..com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "[email protected]:octocat/Hello-World.git", "stargazers_url": "https://api..com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api..com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api..com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api..com/repos/octocat/Hello-World/subscription", "tags_url": "https://api..com/repos/octocat/Hello-World/tags", "teams_url": "https://api..com/repos/octocat/Hello-World/teams", "trees_url": "https://api..com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api..com/repos/octocat/Hello-World/hooks" }, "machine": { "name": "standardLinux", "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, "devcontainer_path": ".devcontainer.json", "created_at": "2021-10-14T00:53:30-06:00", "updated_at": "2021-10-14T00:53:32-06:00", "last_used_at": "2021-10-14T00:53:30-06:00", "state": "Available", "url": "https://api..com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a", "git_status": { "ahead": 0, "behind": 0, "has_unpushed_changes": false, "has_uncommitted_changes": false, "ref": "main" }, "location": "WestUs2", "idle_timeout_minutes": 60, "web_url": "https://monalisa-octocat-hello-world-f8adfad99a..dev", "machines_url": "https://api..com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/machines", "start_url": "https://api..com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/start", "stop_url": "https://api..com/user/codespaces/monalisa-octocat-hello-world-f8adfad99a/stop", "recent_folders": [] } ] }

Deletes a user's codespace.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

Tokens de acesso refinados para "Delete a codespace from the organization"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Codespaces" repository permissions (write) and "Organization codespaces" organization permissions (write)

Parâmetros para "Delete a codespace from the organization"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.
`username` string Obrigatório The handle for the user account.
`codespace_name` string Obrigatório The name of the codespace.

Códigos de status de resposta HTTP para "Delete a codespace from the organization"

Código de status	Descrição
`202`	Accepted
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`500`	Internal Error

Exemplos de código para "Delete a codespace from the organization"

Exemplo de solicitação

delete/orgs/{org}/members/{username}/codespaces/{codespace_name}

curl -L \ -X DELETE \ -H "Accept: application/vnd.+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X--Api-Version: 2022-11-28" \ https://api..com/orgs/ORG/members/USERNAME/codespaces/CODESPACE_NAME

Accepted

Status: 202

Stops a user's codespace.

OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

Tokens de acesso refinados para "Stop a codespace for an organization user"

Esse ponto de extremidade funciona com os seguintes tipos de token refinados:

O token refinado deve ter os seguintes conjuntos de permissões:

"Organization codespaces" organization permissions (write) and "Codespaces lifecycle admin" repository permissions (write)

Parâmetros para "Stop a codespace for an organization user"

Cabeçalhos
Nome, Tipo, Descrição
`accept` string Setting to `application/vnd.+json` is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
`org` string Obrigatório The organization name. The name is not case sensitive.
`username` string Obrigatório The handle for the user account.
`codespace_name` string Obrigatório The name of the codespace.

Códigos de status de resposta HTTP para "Stop a codespace for an organization user"

Código de status	Descrição
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`404`	Resource not found
`500`	Internal Error

Exemplos de código para "Stop a codespace for an organization user"

Exemplo de solicitação

post/orgs/{org}/members/{username}/codespaces/{codespace_name}/stop

curl -L \ -X POST \ -H "Accept: application/vnd.+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X--Api-Version: 2022-11-28" \ https://api..com/orgs/ORG/members/USERNAME/codespaces/CODESPACE_NAME/stop

Response

Status: 200

{ "id": 1, "name": "monalisa-octocat-hello-world-g4wpq6h95q", "environment_id": "26a7c758-7299-4a73-b978-5a92a7ae98a0", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api..com/users/octocat", "html_url": "https://.com/octocat", "followers_url": "https://api..com/users/octocat/followers", "following_url": "https://api..com/users/octocat/following{/other_user}", "gists_url": "https://api..com/users/octocat/gists{/gist_id}", "starred_url": "https://api..com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api..com/users/octocat/subscriptions", "organizations_url": "https://api..com/users/octocat/orgs", "repos_url": "https://api..com/users/octocat/repos", "events_url": "https://api..com/users/octocat/events{/privacy}", "received_events_url": "https://api..com/users/octocat/received_events", "type": "User", "site_admin": false }, "billable_owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api..com/users/octocat", "html_url": "https://.com/octocat", "followers_url": "https://api..com/users/octocat/followers", "following_url": "https://api..com/users/octocat/following{/other_user}", "gists_url": "https://api..com/users/octocat/gists{/gist_id}", "starred_url": "https://api..com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api..com/users/octocat/subscriptions", "organizations_url": "https://api..com/users/octocat/orgs", "repos_url": "https://api..com/users/octocat/repos", "events_url": "https://api..com/users/octocat/events{/privacy}", "received_events_url": "https://api..com/users/octocat/received_events", "type": "User", "site_admin": false }, "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://.com/images/error/octocat_happy.gif", "gravatar_id": "", "url": "https://api..com/users/octocat", "html_url": "https://.com/octocat", "followers_url": "https://api..com/users/octocat/followers", "following_url": "https://api..com/users/octocat/following{/other_user}", "gists_url": "https://api..com/users/octocat/gists{/gist_id}", "starred_url": "https://api..com/users/octocat/starred{/owner}{/repo}", "subscriptions_url": "https://api..com/users/octocat/subscriptions", "organizations_url": "https://api..com/users/octocat/orgs", "repos_url": "https://api..com/users/octocat/repos", "events_url": "https://api..com/users/octocat/events{/privacy}", "received_events_url": "https://api..com/users/octocat/received_events", "type": "User", "site_admin": false }, "private": false, "html_url": "https://.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, "url": "https://api..com/repos/octocat/Hello-World", "archive_url": "https://api..com/repos/octocat/Hello-World/{archive_format}{/ref}", "assignees_url": "https://api..com/repos/octocat/Hello-World/assignees{/user}", "blobs_url": "https://api..com/repos/octocat/Hello-World/git/blobs{/sha}", "branches_url": "https://api..com/repos/octocat/Hello-World/branches{/branch}", "collaborators_url": "https://api..com/repos/octocat/Hello-World/collaborators{/collaborator}", "comments_url": "https://api..com/repos/octocat/Hello-World/comments{/number}", "commits_url": "https://api..com/repos/octocat/Hello-World/commits{/sha}", "compare_url": "https://api..com/repos/octocat/Hello-World/compare/{base}...{head}", "contents_url": "https://api..com/repos/octocat/Hello-World/contents/{+path}", "contributors_url": "https://api..com/repos/octocat/Hello-World/contributors", "deployments_url": "https://api..com/repos/octocat/Hello-World/deployments", "downloads_url": "https://api..com/repos/octocat/Hello-World/downloads", "events_url": "https://api..com/repos/octocat/Hello-World/events", "forks_url": "https://api..com/repos/octocat/Hello-World/forks", "git_commits_url": "https://api..com/repos/octocat/Hello-World/git/commits{/sha}", "git_refs_url": "https://api..com/repos/octocat/Hello-World/git/refs{/sha}", "git_tags_url": "https://api..com/repos/octocat/Hello-World/git/tags{/sha}", "git_url": "git:.com/octocat/Hello-World.git", "issue_comment_url": "https://api..com/repos/octocat/Hello-World/issues/comments{/number}", "issue_events_url": "https://api..com/repos/octocat/Hello-World/issues/events{/number}", "issues_url": "https://api..com/repos/octocat/Hello-World/issues{/number}", "keys_url": "https://api..com/repos/octocat/Hello-World/keys{/key_id}", "labels_url": "https://api..com/repos/octocat/Hello-World/labels{/name}", "languages_url": "https://api..com/repos/octocat/Hello-World/languages", "merges_url": "https://api..com/repos/octocat/Hello-World/merges", "milestones_url": "https://api..com/repos/octocat/Hello-World/milestones{/number}", "notifications_url": "https://api..com/repos/octocat/Hello-World/notifications{?since,all,participating}", "pulls_url": "https://api..com/repos/octocat/Hello-World/pulls{/number}", "releases_url": "https://api..com/repos/octocat/Hello-World/releases{/id}", "ssh_url": "[email protected]:octocat/Hello-World.git", "stargazers_url": "https://api..com/repos/octocat/Hello-World/stargazers", "statuses_url": "https://api..com/repos/octocat/Hello-World/statuses/{sha}", "subscribers_url": "https://api..com/repos/octocat/Hello-World/subscribers", "subscription_url": "https://api..com/repos/octocat/Hello-World/subscription", "tags_url": "https://api..com/repos/octocat/Hello-World/tags", "teams_url": "https://api..com/repos/octocat/Hello-World/teams", "trees_url": "https://api..com/repos/octocat/Hello-World/git/trees{/sha}", "hooks_url": "http://api..com/repos/octocat/Hello-World/hooks" }, "machine": { "name": "standardLinux", "display_name": "4 cores, 16 GB RAM, 64 GB storage", "operating_system": "linux", "storage_in_bytes": 68719476736, "memory_in_bytes": 17179869184, "cpus": 4 }, "prebuild": false, "devcontainer_path": ".devcontainer/devcontainer.json", "created_at": "2021-10-14T00:53:30-06:00", "updated_at": "2021-10-14T00:53:32-06:00", "last_used_at": "2021-10-14T00:53:30-06:00", "state": "Available", "url": "https://api..com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q", "git_status": { "ahead": 0, "behind": 0, "has_unpushed_changes": false, "has_uncommitted_changes": false, "ref": "main" }, "location": "WestUs2", "idle_timeout_minutes": 60, "retention_period_minutes": 43200, "retention_expires_at": null, "web_url": "https://monalisa-octocat-hello-world-g4wpq6h95q..dev", "machines_url": "https://api..com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/machines", "start_url": "https://api..com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/start", "stop_url": "https://api..com/user/codespaces/monalisa-octocat-hello-world-g4wpq6h95q/stop", "pulls_url": "https://api..com/repos/octocat/Hello-World/pulls/1", "recent_folders": [], "template": null }