Module codespaces_api

Enums

CodespacesSlashAddRepositoryForSecretForAuthenticatedUserError

struct for typed errors of method codespaces_slash_add_repository_for_secret_for_authenticated_user

CodespacesSlashAddSelectedRepoToOrgSecretError

struct for typed errors of method codespaces_slash_add_selected_repo_to_org_secret

CodespacesSlashCheckPermissionsForDevcontainerError

struct for typed errors of method codespaces_slash_check_permissions_for_devcontainer

CodespacesSlashCodespaceMachinesForAuthenticatedUserError

struct for typed errors of method codespaces_slash_codespace_machines_for_authenticated_user

CodespacesSlashCreateForAuthenticatedUserError

struct for typed errors of method codespaces_slash_create_for_authenticated_user

CodespacesSlashCreateOrUpdateOrgSecretError

struct for typed errors of method codespaces_slash_create_or_update_org_secret

CodespacesSlashCreateOrUpdateRepoSecretError

struct for typed errors of method codespaces_slash_create_or_update_repo_secret

CodespacesSlashCreateOrUpdateSecretForAuthenticatedUserError

struct for typed errors of method codespaces_slash_create_or_update_secret_for_authenticated_user

CodespacesSlashCreateWithPrForAuthenticatedUserError

struct for typed errors of method codespaces_slash_create_with_pr_for_authenticated_user

CodespacesSlashCreateWithRepoForAuthenticatedUserError

struct for typed errors of method codespaces_slash_create_with_repo_for_authenticated_user

CodespacesSlashDeleteCodespacesAccessUsersError

struct for typed errors of method codespaces_slash_delete_codespaces_access_users

CodespacesSlashDeleteForAuthenticatedUserError

struct for typed errors of method codespaces_slash_delete_for_authenticated_user

CodespacesSlashDeleteFromOrganizationError

struct for typed errors of method codespaces_slash_delete_from_organization

CodespacesSlashDeleteOrgSecretError

struct for typed errors of method codespaces_slash_delete_org_secret

CodespacesSlashDeleteRepoSecretError

struct for typed errors of method codespaces_slash_delete_repo_secret

CodespacesSlashDeleteSecretForAuthenticatedUserError

struct for typed errors of method codespaces_slash_delete_secret_for_authenticated_user

CodespacesSlashExportForAuthenticatedUserError

struct for typed errors of method codespaces_slash_export_for_authenticated_user

CodespacesSlashGetCodespacesForUserInOrgError

struct for typed errors of method codespaces_slash_get_codespaces_for_user_in_org

CodespacesSlashGetExportDetailsForAuthenticatedUserError

struct for typed errors of method codespaces_slash_get_export_details_for_authenticated_user

CodespacesSlashGetForAuthenticatedUserError

struct for typed errors of method codespaces_slash_get_for_authenticated_user

CodespacesSlashGetOrgPublicKeyError

struct for typed errors of method codespaces_slash_get_org_public_key

CodespacesSlashGetOrgSecretError

struct for typed errors of method codespaces_slash_get_org_secret

CodespacesSlashGetPublicKeyForAuthenticatedUserError

struct for typed errors of method codespaces_slash_get_public_key_for_authenticated_user

CodespacesSlashGetRepoPublicKeyError

struct for typed errors of method codespaces_slash_get_repo_public_key

CodespacesSlashGetRepoSecretError

struct for typed errors of method codespaces_slash_get_repo_secret

CodespacesSlashGetSecretForAuthenticatedUserError

struct for typed errors of method codespaces_slash_get_secret_for_authenticated_user

CodespacesSlashListDevcontainersInRepositoryForAuthenticatedUserError

struct for typed errors of method codespaces_slash_list_devcontainers_in_repository_for_authenticated_user

CodespacesSlashListForAuthenticatedUserError

struct for typed errors of method codespaces_slash_list_for_authenticated_user

CodespacesSlashListInOrganizationError

struct for typed errors of method codespaces_slash_list_in_organization

CodespacesSlashListInRepositoryForAuthenticatedUserError

struct for typed errors of method codespaces_slash_list_in_repository_for_authenticated_user

CodespacesSlashListOrgSecretsError

struct for typed errors of method codespaces_slash_list_org_secrets

CodespacesSlashListRepoSecretsError

struct for typed errors of method codespaces_slash_list_repo_secrets

CodespacesSlashListRepositoriesForSecretForAuthenticatedUserError

struct for typed errors of method codespaces_slash_list_repositories_for_secret_for_authenticated_user

CodespacesSlashListSecretsForAuthenticatedUserError

struct for typed errors of method codespaces_slash_list_secrets_for_authenticated_user

CodespacesSlashListSelectedReposForOrgSecretError

struct for typed errors of method codespaces_slash_list_selected_repos_for_org_secret

CodespacesSlashPreFlightWithRepoForAuthenticatedUserError

struct for typed errors of method codespaces_slash_pre_flight_with_repo_for_authenticated_user

CodespacesSlashPublishForAuthenticatedUserError

struct for typed errors of method codespaces_slash_publish_for_authenticated_user

CodespacesSlashRemoveRepositoryForSecretForAuthenticatedUserError

struct for typed errors of method codespaces_slash_remove_repository_for_secret_for_authenticated_user

CodespacesSlashRemoveSelectedRepoFromOrgSecretError

struct for typed errors of method codespaces_slash_remove_selected_repo_from_org_secret

CodespacesSlashRepoMachinesForAuthenticatedUserError

struct for typed errors of method codespaces_slash_repo_machines_for_authenticated_user

CodespacesSlashSetCodespacesAccessError

struct for typed errors of method codespaces_slash_set_codespaces_access

CodespacesSlashSetCodespacesAccessUsersError

struct for typed errors of method codespaces_slash_set_codespaces_access_users

CodespacesSlashSetRepositoriesForSecretForAuthenticatedUserError

struct for typed errors of method codespaces_slash_set_repositories_for_secret_for_authenticated_user

CodespacesSlashSetSelectedReposForOrgSecretError

struct for typed errors of method codespaces_slash_set_selected_repos_for_org_secret

CodespacesSlashStartForAuthenticatedUserError

struct for typed errors of method codespaces_slash_start_for_authenticated_user

CodespacesSlashStopForAuthenticatedUserError

struct for typed errors of method codespaces_slash_stop_for_authenticated_user

CodespacesSlashStopInOrganizationError

struct for typed errors of method codespaces_slash_stop_in_organization

CodespacesSlashUpdateForAuthenticatedUserError

struct for typed errors of method codespaces_slash_update_for_authenticated_user

Functions

codespaces_slash_add_repository_for_secret_for_authenticated_user

Adds a repository to the selected repositories for a user’s development environment secret. 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.

codespaces_slash_add_selected_repo_to_org_secret

Adds a repository to an organization development environment secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

codespaces_slash_check_permissions_for_devcontainer

Checks whether the permissions defined by a given devcontainer configuration have been accepted by the authenticated user. OAuth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.

codespaces_slash_codespace_machines_for_authenticated_user

List the machine types a codespace can transition to use. OAuth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.

codespaces_slash_create_for_authenticated_user

Creates a new codespace, owned by the authenticated user. This endpoint requires either a repository_id OR a pull_request but not both. OAuth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.

codespaces_slash_create_or_update_org_secret

Creates or updates an organization development environment secret with an encrypted value. Encrypt your secret using LibSodium. For more information, see "Encrypting secrets for the REST API." OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

codespaces_slash_create_or_update_repo_secret

Creates or updates a repository development environment secret with an encrypted value. Encrypt your secret using LibSodium. For more information, see "Encrypting secrets for the REST API." OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

codespaces_slash_create_or_update_secret_for_authenticated_user

Creates or updates a development environment secret for a user’s codespace with an encrypted value. Encrypt your secret using LibSodium. For more information, see "Encrypting secrets for the REST API." 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.

codespaces_slash_create_with_pr_for_authenticated_user

Creates a codespace owned by the authenticated user for the specified pull request. OAuth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.

codespaces_slash_create_with_repo_for_authenticated_user

Creates a codespace owned by the authenticated user in the specified repository. OAuth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.

codespaces_slash_delete_codespaces_access_users

Codespaces for the specified users will no longer 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.

codespaces_slash_delete_for_authenticated_user

Deletes a user’s codespace. OAuth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.

codespaces_slash_delete_from_organization

Deletes a user’s codespace. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

codespaces_slash_delete_org_secret

Deletes an organization development environment secret using the secret name. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

codespaces_slash_delete_repo_secret

Deletes a development environment secret in a repository using the secret name. OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

codespaces_slash_delete_secret_for_authenticated_user

Deletes a development environment secret from a user’s codespaces using the secret name. Deleting the secret will remove access from all codespaces that were allowed to access the secret. 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.

codespaces_slash_export_for_authenticated_user

Triggers an export of the specified codespace and returns a URL and ID where the status of the export can be monitored. If changes cannot be pushed to the codespace’s repository, they will be pushed to a new or previously-existing fork instead. OAuth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.

codespaces_slash_get_codespaces_for_user_in_org

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.

codespaces_slash_get_export_details_for_authenticated_user

Gets information about an export of a codespace. OAuth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.

codespaces_slash_get_for_authenticated_user

Gets information about a user’s codespace. OAuth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.

codespaces_slash_get_org_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. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

codespaces_slash_get_org_secret

Gets an organization development environment secret without revealing its encrypted value. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

codespaces_slash_get_public_key_for_authenticated_user

Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. 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.

codespaces_slash_get_repo_public_key

Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private, OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

codespaces_slash_get_repo_secret

Gets a single repository development environment secret without revealing its encrypted value. OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

codespaces_slash_get_secret_for_authenticated_user

Gets a development environment secret available to a user’s codespaces without revealing its encrypted value. 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.

codespaces_slash_list_devcontainers_in_repository_for_authenticated_user

Lists the devcontainer.json files associated with a specified repository and the authenticated user. These files specify launchpoint configurations for codespaces created within the repository. OAuth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.

codespaces_slash_list_for_authenticated_user

Lists the authenticated user’s codespaces. OAuth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.

codespaces_slash_list_in_organization

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.

codespaces_slash_list_in_repository_for_authenticated_user

Lists the codespaces associated to a specified repository and the authenticated user. OAuth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.

codespaces_slash_list_org_secrets

Lists all Codespaces development environment secrets available at the organization-level without revealing their encrypted values. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

codespaces_slash_list_repo_secrets

Lists all development environment secrets available in a repository without revealing their encrypted values. OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

codespaces_slash_list_repositories_for_secret_for_authenticated_user

List the repositories that have been granted the ability to use a user’s development environment secret. 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.

codespaces_slash_list_secrets_for_authenticated_user

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.

codespaces_slash_list_selected_repos_for_org_secret

Lists all repositories that have been selected when the visibility for repository access to a secret is set to selected. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

codespaces_slash_pre_flight_with_repo_for_authenticated_user

Gets the default attributes for codespaces created by the user with the repository. OAuth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.

codespaces_slash_publish_for_authenticated_user

Publishes an unpublished codespace, creating a new repository and assigning it to the codespace. The codespace’s token is granted write permissions to the repository, allowing the user to push their changes. This will fail for a codespace that is already published, meaning it has an associated repository. OAuth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.

codespaces_slash_remove_repository_for_secret_for_authenticated_user

Removes a repository from the selected repositories for a user’s development environment secret. 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.

codespaces_slash_remove_selected_repo_from_org_secret

Removes a repository from an organization development environment secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

codespaces_slash_repo_machines_for_authenticated_user

List the machine types available for a given repository based on its configuration. OAuth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.

codespaces_slash_set_codespaces_access

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.

codespaces_slash_set_codespaces_access_users

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.

codespaces_slash_set_repositories_for_secret_for_authenticated_user

Select the repositories that will use a user’s development environment secret. 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.

codespaces_slash_set_selected_repos_for_org_secret

Replaces all repositories for an organization development environment secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

codespaces_slash_start_for_authenticated_user

Starts a user’s codespace. OAuth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.

codespaces_slash_stop_for_authenticated_user

Stops a user’s codespace. OAuth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.

codespaces_slash_stop_in_organization

Stops a user’s codespace. OAuth app tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

codespaces_slash_update_for_authenticated_user

Updates a codespace owned by the authenticated user. Currently only the codespace’s machine type and recent folders can be modified using this endpoint. If you specify a new machine type it will be applied the next time your codespace is started. OAuth app tokens and personal access tokens (classic) need the codespace scope to use this endpoint.