Codespaces

Enterprise Cloud

Enterprise Server

Enterprise Server 3.6

Enterprise Server 3.7

Enterprise Server 3.8

Enterprise Server 3.9

Free, Pro, & Team

GitHub AE

REST API

Toute la documentation GitHub est open source. Vous voyez quelque chose qui n’est pas correct ou qui n’est pas clair ? Envoyez une demande de tirage.

Aidez-nous à rendre ces documents formidables !

De l’aide, où que vous en soyez dans votre parcours sur GitHub.

Peut être

Tous les guides {{ name }}

Parcours d’apprentissage {{ name }}

Actions

GitHub a commencé à déployer ces changements pour les entreprises le

Entrez un terme de recherche pour le trouver dans la documentation GitHub.

Codespaces - Documentation GitHub

Utilisez l’API REST pour gérer GitHub Codespaces.

English

Simplified Chinese

Spanish

Portuguese

Russian

Japanese

French

German

Korean

Démarrage rapide

À propos des API GitHub

Ressources disponibles dans l’API REST

Versions des API

Types de médias

Authentification

Sécurisation des informations d’identification de l’API

Dépannage

Bibliothèques

Description d’OpenAPI

Points de terminaison pour les jetons d’installation d’application GitHub

Points de terminaison pour les jetons d’utilisateur d’application GitHub

Points de terminaison pour les jetons d’accès personnels affinés

Autorisations pour les applications GitHub

Autorisations pour les jetons d’accès personnels affinés

Changements cassants

Vue d’ensemble

Utilisation de l’API

Écrire des scripts avec JavaScript

Découvrir les ressources pour un utilisateur

Livraison de déploiements

Rendu des données sous forme de graphes

Utilisation des commentaires

Pagination

Création d’un serveur CI

Bonnes pratiques pour les intégrateurs

Bien démarrer - Base de données Git

Bien démarrer - Vérifications

Guides

Artifacts

Cache

OIDC

Autorisations

Secrets

Exécuteurs auto-hébergés

Variables

Travaux de workflow

Workflow runs

Workflows

Événements

Flux

Notifications

Attribution d’étoiles

Visionnage

Activité

Applications GitHub

Installations

Place de marché

Autorisations OAuth

Webhooks

Applications

Facturation

Branches

Branches protégées

Exécutions de vérifications

Suites de vérifications

Vérifications

Codes of conduct

Analyse du code

Organisations

Secrets de l’organisation

virtuelles

Secrets de dépôt

Secrets utilisateur

Collaborateurs

Invitations

Commits

Commentaires de commit

États de validation

Copilot for Business

Copilot

Alertes

Dependabot

Vérification des dépendances

Soumission de dépendances

Nomenclature logicielle (SBOM)

Graphe de dépendances

Clés de déploiement

Stratégies de branche de déploiement

Déploiements

Environnements

Règles de protection

États des déploiements

Emojis

Gists

Commentaires

Objets blob

Références

Étiquettes

Arborescences

Base de données Git

Gitignore

Organisation

Référentiel

Utilisateur

Interactions

Problèmes

Personnes responsables

Étapes majeures

Durée

Licences

Markdown

Communauté

Statistiques

Trafic

Mesures

Source Imports

Utilisateurs

Migrations

Blocage d’utilisateurs

Membres

Collaborateurs externes

Jetons d'accès personnels

Règles

Gestionnaires de sécurité

Paquets

Pages

Boards

Cartes

Colonnes

Projects (classic)

Tirages

Commentaires d’évaluation

Passer en revue les demandes

Révisions

Limite du taux

Réactions

Publications

Ressources de mise en production

Liens automatiques

Contenu

Fourches

Git LFS

Référentiels

Rechercher

Analyse de secrets

Secret scanning

Avis de sécurité des dépôts

Avis de sécurité

Teams

Commentaires de discussion

Discussions

E-mails

Abonnés

Clés GPG

Clés SSH Git

Clés de signature SSH

Comptes sociaux

Configuration du webhook d’un dépôt

Livraisons de webhooks d’un dépôt

Webhooks de dépôt

API REST

monalisa-octocat-hello-world-g4wpq6h95q

monalisa-octocat-hello-world-3f89ada1j3

Lists the codespaces associated to a specified repository and the authenticated user.
You must authenticate using an access token with the <code>codespace</code> scope to use this endpoint.
GitHub Apps must have read access to the <code>codespaces</code> repository permission to use this endpoint.

The number of results per page (max 100).

per_page

Page number of the results to fetch.

page

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

owner

The name of the repository without the <code>.git</code> extension. The name is not case sensitive.

repo

List codespaces in a repository for the authenticated user

Git ref (typically a branch name) for this codespace

The requested location for a new codespace. Best efforts are made to respect this upon creation. Assigned by IP if not provided.

location

The geographic area for this codespace. If not specified, the value is assigned by IP. This property replaces <code>location</code>, which is being deprecated.

IP for location auto-detection when proxying a request

client_ip

Creates a codespace owned by the authenticated user in the specified repository.
You must authenticate using an access token with the <code>codespace</code> scope to use this endpoint.
GitHub Apps must have write access to the <code>codespaces</code> repository permission to use this endpoint.

Create a codespace in a repository