List devcontainer configurations in a repository for the authenticated user

GET

/repos/{owner}/{repo}/codespaces/devcontainers

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.

You must authenticate using an access token with the codespace scope to use this endpoint.

GitHub Apps must have read access to the codespaces_metadata repository permission to use this endpoint.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.github.com/repos///codespaces/devcontainers'

Response Example

200 - Example 1

{
    "devcontainers": [
        {
            "name": "string",
            "path": "string"
        }
    ],
    "total_count": 0
}

Request

Path Params

owner

string

required

The account owner of the repository. The name is not case sensitive.

repo

string

required

The name of the repository. The name is not case sensitive.

Query Params

per_page

integer

optional

The number of results per page (max 100).

page

integer

optional

Page number of the results to fetch.

Responses

🟢200Response

application/json

Body

devcontainers

array [object {2}]

required

name

string

optional

path

string

required

total_count

integer

required

🟠400400

🟠401401

🟠403403

🟠404404

🔴500500

Modified at 2023-08-15 02:59:24

Create a codespace in a repository

List available machine types for a repository