mirror of
https://github.com/jlengrand/jetbrains-client-api-repository.git
synced 2026-03-10 08:31:24 +00:00
381 lines
12 KiB
HTTP
381 lines
12 KiB
HTTP
## CodespacesApi
|
|
|
|
### Add a selected repository to a user secret
|
|
## Add a selected repository to a user secret
|
|
PUT https://api.github.com/user/codespaces/secrets/{{secret_name}}/repositories/{{repository_id}}
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### Add selected repository to an organization secret
|
|
## Add selected repository to an organization secret
|
|
PUT https://api.github.com/orgs/{{org}}/codespaces/secrets/{{secret_name}}/repositories/{{repository_id}}
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### Check if permissions defined by a devcontainer have been accepted by the authenticated user
|
|
## Check if permissions defined by a devcontainer have been accepted by the authenticated user
|
|
GET https://api.github.com/repos/{{owner}}/{{repo}}/codespaces/permissions_check
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### List machine types for a codespace
|
|
## List machine types for a codespace
|
|
GET https://api.github.com/user/codespaces/{{codespace_name}}/machines
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### Create a codespace for the authenticated user
|
|
## Create a codespace for the authenticated user
|
|
POST https://api.github.com/user/codespaces
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
{
|
|
"repository_id" : 1,
|
|
"ref" : "main",
|
|
"geo" : "UsWest"
|
|
}
|
|
|
|
|
|
### Create or update an organization secret
|
|
## Create or update an organization secret
|
|
PUT https://api.github.com/orgs/{{org}}/codespaces/secrets/{{secret_name}}
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
{
|
|
"encrypted_value" : "c2VjcmV0",
|
|
"key_id" : "012345678912345678",
|
|
"visibility" : "selected",
|
|
"selected_repository_ids" : [ 1296269, 1296280 ]
|
|
}
|
|
|
|
|
|
### Create or update a repository secret
|
|
## Create or update a repository secret
|
|
PUT https://api.github.com/repos/{{owner}}/{{repo}}/codespaces/secrets/{{secret_name}}
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
{
|
|
"encrypted_value" : "c2VjcmV0",
|
|
"key_id" : "012345678912345678"
|
|
}
|
|
|
|
|
|
### Create or update a secret for the authenticated user
|
|
## Create or update a secret for the authenticated user
|
|
PUT https://api.github.com/user/codespaces/secrets/{{secret_name}}
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
{
|
|
"encrypted_value" : "c2VjcmV0",
|
|
"key_id" : "012345678912345678",
|
|
"selected_repository_ids" : [ "1234567", "2345678" ]
|
|
}
|
|
|
|
|
|
### Create a codespace from a pull request
|
|
## Create a codespace from a pull request
|
|
POST https://api.github.com/repos/{{owner}}/{{repo}}/pulls/{{pull_number}}/codespaces
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
{
|
|
"repository_id" : 1,
|
|
"ref" : "main"
|
|
}
|
|
|
|
|
|
### Create a codespace in a repository
|
|
## Create a codespace in a repository
|
|
POST https://api.github.com/repos/{{owner}}/{{repo}}/codespaces
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
Accept: application/scim+json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
{
|
|
"ref" : "main",
|
|
"machine" : "standardLinux32gb"
|
|
}
|
|
|
|
|
|
### Remove users from Codespaces access for an organization
|
|
## Remove users from Codespaces access for an organization
|
|
DELETE https://api.github.com/orgs/{{org}}/codespaces/access/selected_users
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
{
|
|
"selected_usernames" : [ "johnDoe", "atomIO" ]
|
|
}
|
|
|
|
|
|
### Delete a codespace for the authenticated user
|
|
## Delete a codespace for the authenticated user
|
|
DELETE https://api.github.com/user/codespaces/{{codespace_name}}
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### Delete a codespace from the organization
|
|
## Delete a codespace from the organization
|
|
DELETE https://api.github.com/orgs/{{org}}/members/{{username}}/codespaces/{{codespace_name}}
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### Delete an organization secret
|
|
## Delete an organization secret
|
|
DELETE https://api.github.com/orgs/{{org}}/codespaces/secrets/{{secret_name}}
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### Delete a repository secret
|
|
## Delete a repository secret
|
|
DELETE https://api.github.com/repos/{{owner}}/{{repo}}/codespaces/secrets/{{secret_name}}
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### Delete a secret for the authenticated user
|
|
## Delete a secret for the authenticated user
|
|
DELETE https://api.github.com/user/codespaces/secrets/{{secret_name}}
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### Export a codespace for the authenticated user
|
|
## Export a codespace for the authenticated user
|
|
POST https://api.github.com/user/codespaces/{{codespace_name}}/exports
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### List codespaces for a user in organization
|
|
## List codespaces for a user in organization
|
|
GET https://api.github.com/orgs/{{org}}/members/{{username}}/codespaces
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### Get details about a codespace export
|
|
## Get details about a codespace export
|
|
GET https://api.github.com/user/codespaces/{{codespace_name}}/exports/{{export_id}}
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### Get a codespace for the authenticated user
|
|
## Get a codespace for the authenticated user
|
|
GET https://api.github.com/user/codespaces/{{codespace_name}}
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### Get an organization public key
|
|
## Get an organization public key
|
|
GET https://api.github.com/orgs/{{org}}/codespaces/secrets/public-key
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### Get an organization secret
|
|
## Get an organization secret
|
|
GET https://api.github.com/orgs/{{org}}/codespaces/secrets/{{secret_name}}
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### Get public key for the authenticated user
|
|
## Get public key for the authenticated user
|
|
GET https://api.github.com/user/codespaces/secrets/public-key
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### Get a repository public key
|
|
## Get a repository public key
|
|
GET https://api.github.com/repos/{{owner}}/{{repo}}/codespaces/secrets/public-key
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### Get a repository secret
|
|
## Get a repository secret
|
|
GET https://api.github.com/repos/{{owner}}/{{repo}}/codespaces/secrets/{{secret_name}}
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### Get a secret for the authenticated user
|
|
## Get a secret for the authenticated user
|
|
GET https://api.github.com/user/codespaces/secrets/{{secret_name}}
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### List devcontainer configurations in a repository for the authenticated user
|
|
## List devcontainer configurations in a repository for the authenticated user
|
|
GET https://api.github.com/repos/{{owner}}/{{repo}}/codespaces/devcontainers
|
|
Accept: application/json
|
|
Accept: application/scim+json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### List codespaces for the authenticated user
|
|
## List codespaces for the authenticated user
|
|
GET https://api.github.com/user/codespaces
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### List codespaces for the organization
|
|
## List codespaces for the organization
|
|
GET https://api.github.com/orgs/{{org}}/codespaces
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### List codespaces in a repository for the authenticated user
|
|
## List codespaces in a repository for the authenticated user
|
|
GET https://api.github.com/repos/{{owner}}/{{repo}}/codespaces
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### List organization secrets
|
|
## List organization secrets
|
|
GET https://api.github.com/orgs/{{org}}/codespaces/secrets
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### List repository secrets
|
|
## List repository secrets
|
|
GET https://api.github.com/repos/{{owner}}/{{repo}}/codespaces/secrets
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### List selected repositories for a user secret
|
|
## List selected repositories for a user secret
|
|
GET https://api.github.com/user/codespaces/secrets/{{secret_name}}/repositories
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### List secrets for the authenticated user
|
|
## List secrets for the authenticated user
|
|
GET https://api.github.com/user/codespaces/secrets
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### List selected repositories for an organization secret
|
|
## List selected repositories for an organization secret
|
|
GET https://api.github.com/orgs/{{org}}/codespaces/secrets/{{secret_name}}/repositories
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### Get default attributes for a codespace
|
|
## Get default attributes for a codespace
|
|
GET https://api.github.com/repos/{{owner}}/{{repo}}/codespaces/new
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### Create a repository from an unpublished codespace
|
|
## Create a repository from an unpublished codespace
|
|
POST https://api.github.com/user/codespaces/{{codespace_name}}/publish
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
{
|
|
"repository" : "monalisa-octocat-hello-world-g4wpq6h95q",
|
|
"private" : false
|
|
}
|
|
|
|
|
|
### Remove a selected repository from a user secret
|
|
## Remove a selected repository from a user secret
|
|
DELETE https://api.github.com/user/codespaces/secrets/{{secret_name}}/repositories/{{repository_id}}
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### Remove selected repository from an organization secret
|
|
## Remove selected repository from an organization secret
|
|
DELETE https://api.github.com/orgs/{{org}}/codespaces/secrets/{{secret_name}}/repositories/{{repository_id}}
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### List available machine types for a repository
|
|
## List available machine types for a repository
|
|
GET https://api.github.com/repos/{{owner}}/{{repo}}/codespaces/machines
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### Manage access control for organization codespaces
|
|
## Manage access control for organization codespaces
|
|
PUT https://api.github.com/orgs/{{org}}/codespaces/access
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
{
|
|
"visibility" : "selected_members",
|
|
"selected_usernames" : [ "johnDoe", "atomIO" ]
|
|
}
|
|
|
|
|
|
### Add users to Codespaces access for an organization
|
|
## Add users to Codespaces access for an organization
|
|
POST https://api.github.com/orgs/{{org}}/codespaces/access/selected_users
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
{
|
|
"selected_usernames" : [ "johnDoe", "atomIO" ]
|
|
}
|
|
|
|
|
|
### Set selected repositories for a user secret
|
|
## Set selected repositories for a user secret
|
|
PUT https://api.github.com/user/codespaces/secrets/{{secret_name}}/repositories
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
{
|
|
"selected_repository_ids" : [ "1296269", "1296280" ]
|
|
}
|
|
|
|
|
|
### Set selected repositories for an organization secret
|
|
## Set selected repositories for an organization secret
|
|
PUT https://api.github.com/orgs/{{org}}/codespaces/secrets/{{secret_name}}/repositories
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
{
|
|
"selected_repository_ids" : [ 64780797 ]
|
|
}
|
|
|
|
|
|
### Start a codespace for the authenticated user
|
|
## Start a codespace for the authenticated user
|
|
POST https://api.github.com/user/codespaces/{{codespace_name}}/start
|
|
Accept: application/json
|
|
Accept: application/scim+json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### Stop a codespace for the authenticated user
|
|
## Stop a codespace for the authenticated user
|
|
POST https://api.github.com/user/codespaces/{{codespace_name}}/stop
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### Stop a codespace for an organization user
|
|
## Stop a codespace for an organization user
|
|
POST https://api.github.com/orgs/{{org}}/members/{{username}}/codespaces/{{codespace_name}}/stop
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
### Update a codespace for the authenticated user
|
|
## Update a codespace for the authenticated user
|
|
PATCH https://api.github.com/user/codespaces/{{codespace_name}}
|
|
Content-Type: application/json
|
|
Accept: application/json
|
|
Authorization: Bearer {{bearerToken}}
|
|
|
|
{
|
|
"machine" : "standardLinux"
|
|
}
|
|
|