API HTTP
Los endpoints que usa el CLI, para integrar ArgyHost desde tus propias herramientas.
Actualizado: 2026-11-15
Estado de la API
Es la misma API que usa el portal (versión 0). Puede cambiar sin aviso: para automatizar, preferí el CLI con --json, que valida cada respuesta y se mantiene compatible.
- Base:
https://portal.argysolutions.com. - Cuerpos en JSON (
Content-Type: application/json), salvo la subida de archivos. {id}es el identificador del sitio (external_iden el listado,iden el CLI).- Los errores responden
{ "success": false, "message": "…" }.
| HTTP | Significado |
|---|---|
| 400 | Datos inválidos; message explica cuál. |
| 401 | Sin sesión o token vencido. |
| 403 | La suscripción no permite la acción. |
| 404 | El sitio o recurso no existe en tu cuenta. |
| 409 / 429 | Ya hay una operación en curso sobre el sitio. |
| 502 / 503 | El servidor de hosting no respondió; reintentar más tarde. |
Autenticación por dispositivo
Flujo RFC 8628. Todas las demás llamadas llevan Authorization: Bearer <token>.
curl -X POST https://portal.argysolutions.com/api/auth/device/code \
-H "Content-Type: application/json" -d '{"client_id":"argy-cli"}'{
"device_code": "…",
"user_code": "ABCD2345",
"verification_uri": "https://portal.argysolutions.com/device",
"verification_uri_complete": "https://portal.argysolutions.com/device?user_code=ABCD2345",
"expires_in": 600,
"interval": 5
}La persona abre verification_uri_complete y aprueba. Mientras tanto, cada interval segundos:
curl -X POST https://portal.argysolutions.com/api/auth/device/token \
-H "Content-Type: application/json" \
-d '{"grant_type":"urn:ietf:params:oauth:grant-type:device_code",
"device_code":"…","client_id":"argy-cli"}'| Respuesta | Qué hacer |
|---|---|
200 { access_token, token_type, expires_in } | Listo: usar access_token como Bearer. |
400 authorization_pending | Seguir consultando. |
400 slow_down | Sumar 5 segundos al intervalo. |
400 access_denied | La persona rechazó el pedido. |
400 expired_token | El código venció: empezar de nuevo. |
400 invalid_client | client_id distinto de argy-cli. |
| Método y ruta | Uso |
|---|---|
GET /api/auth/get-session | Cuenta del token: { user: { id, email, name } } o null. |
POST /api/auth/sign-out | Revoca el token. Cuerpo {}. |
Sitios
| Método y ruta | Cuerpo | Respuesta |
|---|---|---|
GET /api/dashboard/sites | - | { sites: [{ external_id, subdomain, domain, custom_domain, app_type, resource_type, status, live, last_deploy_at, deployment_phase, last_build_failure, git }] } |
POST /api/dashboard/sites/create | { subdomain, siteType: "upload", uploadMode: "static" | "build", customDomain? } | { externalId, domain } |
GET /api/dashboard/sites/{id}/status | - | { published, status, rawStatus, containers: [{ name, status, ready, restarts, reason }], lastDeployAt } |
POST /api/dashboard/sites/{id}/action | { action: "start" | "stop" | "restart" | "delete" } | { message } |
status del listado: running, stopped, degraded, crashing, queued, building, deploy_failed, pending_setup, provisioning, provisioning_failed o unpublished.
Deploys
| Método y ruta | Cuerpo | Respuesta |
|---|---|---|
POST /api/uploads/sites/{id} | tar.gz del proyecto (Content-Type: application/gzip, hasta 200 MB, raíz del proyecto en la raíz del archivo) | Estático: 200 { status: "published", releaseId, url, paused }. Con build: 202 { status: "queued", detected }. |
POST /api/dashboard/sites/{id}/deploy | {} (sitios de GitHub) | 202 { status: "queued", commit } o 200 { message } |
GET /api/dashboard/sites/{id}/deployments | - | { deployments: [{ uuid, status: "success" | "failed", createdAt, finishedAt, commit, commitMessage, runtimeFailed }] } (últimos 10) |
GET /api/dashboard/sites/{id}/deployments?logs={uuid} | - | { deployment, logsRestricted, logs: [{ type, line }] } |
POST /api/dashboard/sites/{id}/releases | { releaseId } (sitios estáticos) | { releaseId } |
GET /api/dashboard/sites/{id}/logs?lines=200 | - | { restricted, lines: string[] } (10 a 500 líneas) |
Para saber cuándo terminó un deploy con build: consultar cada 5 segundos GET /api/dashboard/sites (falla si status es deploy_failed) y GET …/deployments hasta que aparezca un deploy creado después del pedido. Así lo hace argy deploy.
Variables de entorno
| Método y ruta | Cuerpo | Respuesta |
|---|---|---|
GET /api/dashboard/sites/{id}/env | - | { envs: [{ uuid, key, build, system, valueState }] } (sin valores) |
GET /api/dashboard/sites/{id}/env/{CLAVE} | - | { key, value } |
POST /api/dashboard/sites/{id}/env | { key, value, build?, noRestart? } | { restarted, envs } |
PATCH /api/dashboard/sites/{id}/env | { variables: [{ key, value }] (1 a 50), build?, noRestart? } | { restarted, created, updated, envs } |
DELETE /api/dashboard/sites/{id}/env?envUuid={uuid}&noRestart=true | - | { restarted, envs } |
Dominios
| Método y ruta | Cuerpo | Respuesta |
|---|---|---|
POST /api/dashboard/sites/{id}/domain | { domain } | { domain } |
DELETE /api/dashboard/sites/{id}/domain | - | { domain, message } (el subdominio que queda activo) |