devcontainers

Creates, updates, deletes, gets or lists a devcontainers resource.

Overview

Name	devcontainers
Type	Resource
Id	github.codespaces.devcontainers

Fields

The following fields are returned by SELECT queries:

list_devcontainers_in_repository_for_authenticated_user

Response

Name	Datatype	Description
devcontainers	array
total_count	integer

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_devcontainers_in_repository_for_authenticated_user	select	owner, repo	per_page, page	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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
owner	string	The account owner of the repository. The name is not case sensitive.
repo	string	The name of the repository without the .git extension. The name is not case sensitive.
page	integer	The page number of the results to fetch. For more information, see "Using pagination in the REST API."
per_page	integer	The number of results per page (max 100). For more information, see "Using pagination in the REST API."

SELECT examples

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.

SELECT
devcontainers,
total_count
FROM github.codespaces.devcontainers
WHERE owner = '{{ owner }}' -- required
AND repo = '{{ repo }}' -- required
AND per_page = '{{ per_page }}'
AND page = '{{ page }}'
;