API REST
Gérez les ressources de votre compte via HTTP avec une clé API bearer.
L’API REST se trouve sous https://api.gheima.ma/v1 et couvre ce que vous faites dans le tableau de bord. Authentifiez-vous avec une clé API passée en jeton bearer. La limite de débit s’applique par clé et dépend de votre plan : de 60 requêtes par minute sur Free à 1 200 sur Agency. Les en-têtes de réponse X-RateLimit-* indiquent ce qu’il vous reste. La spécification complète, lisible par machine, est sur /api/v1/openapi.json.
Shell
# List services (cursor-paginated: ?limit=&cursor=&type=WEB|WORKER|STATIC)
curl "https://api.gheima.ma/v1/services?limit=20" \
-H "Authorization: Bearer gh_xxxxx"
# Create a service
curl -X POST https://api.gheima.ma/v1/services \
-H "Authorization: Bearer gh_xxxxx" -H "content-type: application/json" \
-d '{"projectId":"prj_1","name":"web","repoUrl":"https://github.com/me/app"}'
# Trigger a deployment -> 202 { deploymentId }
curl -X POST https://api.gheima.ma/v1/services/<id>/deploy \
-H "Authorization: Bearer gh_xxxxx"Les endpoints de liste sont paginés par curseur. Passez ?limit= (1 à 100, 20 par défaut) et ?cursor=, puis lisez le curseur suivant dans pagination.nextCursor de la réponse.
✦ Tout langage capable d’une requête HTTP peut piloter Gheima.