project.read
Markdownv0.3.0
Lire les métadonnées d'un projet et l'état de ses déploiements.
- API
GET /v1/projects/{projectId} - MCP
project_read - CLI
bastide project read
| Propriété | Valeur |
|---|---|
| Niveau | project |
| Rang minimal | reader |
| Rôle transversal | — |
| Portées | project:read |
| Compte de service | la lit, sous son rang et ses portées |
| Réversibilité | N — lecture seule, aucun effet |
| Idempotence | une lecture, rejouable sans précaution |
| Limites de débit, par jeton | 600 appels par 60 secondes (general) |
API
GET /v1/projects/{projectId} — succès en 200.
| Paramètre | Où | Type | Requis | Description |
|---|---|---|---|---|
projectId | chemin | texte, motif ^prj_[0-9A-HJKMNP-TV-Z]{26}$ | oui | Identifiant de projet |
derive | requête | booléen | non |
La réponse :
| Champ | Type | Description |
|---|---|---|
id | texte, motif ^prj_[0-9A-HJKMNP-TV-Z]{26}$ | Identifiant de projet |
expiresAt | texte, format date-time, ou nul | |
slug | texte, motif ^[a-z0-9][a-z0-9-]{1,62}$ | Identifiant lisible, unique dans son périmètre |
name | objet (untrusted, source, content) | |
organizationId | texte, motif ^org_[0-9A-HJKMNP-TV-Z]{26}$ | Identifiant de organisation |
tier | l'un de discovery, standard, pro, sovereign | |
status | l'un de active, suspended, closing | |
defaultBranch | texte | |
gitRemote | objet (untrusted, source, content), ou nul | Adresse du dépôt Git, sans les identifiants, les paramètres ni le fragment qu'elle pouvait porter. Nul : aucun dépôt déclaré. |
rootDirectory | objet (untrusted, source, content), ou nul | |
includePaths | liste — chaque élément : texte | |
registresAdmis | liste — chaque élément : texte | |
veilleMinutes | entier | Minutes sans requête après lesquelles un environnement de ce projet qui peut dormir s'arrête. |
veilleEnvironnementsPersonnalises | booléen | Vrai quand les environnements personnalisés de ce projet dorment aussi. |
licencesContaminantesBloquantes | booléen | Vrai quand un paquet sous licence AGPL, SSPL ou BUSL fait échouer la construction de ce projet ; faux, il est seulement signalé. |
sortie | objet (mode, domaines, smtp) | |
instances | entier | Nombre d'exemplaires du service de production, de 1 à 10. Les autres environnements en tiennent toujours un. |
fuseau | texte | Fuseau dans lequel se lisent les heures de l'ordonnancement. |
horaires | liste — chaque élément : objet (heure, exemplaires) | Ordonnancement horaire du nombre d'exemplaires de production, par heure croissante. Vide : aucun ordonnancement, le réglage manuel tient. |
createdAt | texte, format date-time | |
createdBy | objet (accountId, serviceTokenId, agentSession, channel), ou nul | |
derive | objet (statut, divergences, empechement) | |
support | objet (niveau, phrase), ou nul | |
billingEntityId | texte, motif ^bil_[0-9A-HJKMNP-TV-Z]{26}$ | L'entité contractante de l'organisation, que nomme usage.read. |
lastAgentAction | objet (operation, at, by), ou nul | |
pendingDeletion | objet (deletionId, state, requestedBy, requestedAt, acceptBefore, scheduledFor), ou nul | La suppression demandée ou planifiée de ce projet. Nulle : aucune n'est en cours. |
En-têtes de la réponse : RateLimit-Limit, RateLimit-Remaining, RateLimit-Reset, RateLimit-Policy.
Autres réponses : 400, 401, 403, 404, 409, 429, 500, 503 — communes à toute opération.
Ligne de commande
bastide project read --project-id <valeur>
| Option | Type | Requise | Défaut | Description |
|---|---|---|---|---|
--project-id | texte | oui | — | Identifiant de projet |
--derive | booléen | non | — |
La commande s'exécute sans confirmation.
MCP
Outil project_read.
| Propriété | Valeur |
|---|---|
| Lecture seule | oui |
| Destructif | non |
| Idempotent | non |
| Monde ouvert | non |
| Confirmation en deux temps | non |
| Budget de jetons du résultat | 800 |
Erreurs
Aucun code propre à cette opération.
S'y ajoutent les refus communs à toute opération — entrée invalide, authentification, autorisation, cible introuvable, conflit, limite de débit, indisponibilité — que le catalogue des erreurs décrit.
Exemples
Lire un projet avec sa dérive de configuration :
{
"projectId": "prj_01JQ8ZK4M7NP2RSTVWXYZ34567",
"derive": true
}