Creates a codespace owned by the authenticated user for the specified pull request.
You must authenticate using an access token with the codespace scope to use this endpoint.
GitHub Apps must have write access to the codespaces repository permission to use this endpoint.
Create a codespace from a pull request
Arguments
Returns
codespace [object]
A codespace.
Attributes
Path to devcontainer.json from repo root used to create Codespace.
Display name for this codespace.
UUID identifying this codespace's environment.
Details about the codespace's git repository.
The number of minutes of inactivity after which this codespace will be automatically stopped.
Text to show user when codespace idle timeout minutes has been overriden by an organization policy
The text to display to a user when a codespace has been stopped for a potentially actionable reason.
Last known time this codespace was started.
The Azure region where this codespace is located.
API URL to access available alternate machine types for this codespace.
Automatically generated name of this codespace.
Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it.
Text to show user when codespace is disabled by a pending operation
Whether the codespace was created from a prebuild.
API URL to publish this codespace to a new repository.
API URL for the Pull Request associated with this codespace, if any.
When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at"
Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).
API URL to start this codespace.
State of this codespace.
API URL to stop this codespace.
API URL for this codespace.
URL to access this codespace on the web.
codespace [object]
A codespace.
Attributes
Path to devcontainer.json from repo root used to create Codespace.
Display name for this codespace.
UUID identifying this codespace's environment.
Details about the codespace's git repository.
The number of minutes of inactivity after which this codespace will be automatically stopped.
Text to show user when codespace idle timeout minutes has been overriden by an organization policy
The text to display to a user when a codespace has been stopped for a potentially actionable reason.
Last known time this codespace was started.
The Azure region where this codespace is located.
API URL to access available alternate machine types for this codespace.
Automatically generated name of this codespace.
Whether or not a codespace has a pending async operation. This would mean that the codespace is temporarily unavailable. The only thing that you can do with a codespace in this state is delete it.
Text to show user when codespace is disabled by a pending operation
Whether the codespace was created from a prebuild.
API URL to publish this codespace to a new repository.
API URL for the Pull Request associated with this codespace, if any.
When a codespace will be auto-deleted based on the "retention_period_minutes" and "last_used_at"
Duration in minutes after codespace has gone idle in which it will be deleted. Must be integer minutes between 0 and 43200 (30 days).
API URL to start this codespace.
State of this codespace.
API URL to stop this codespace.
API URL for this codespace.
URL to access this codespace on the web.
requires_authentication [scalar]
Requires authentication
service_unavailable [scalar]
Service unavailable