La referencia de la API se publica en inglés.
Control a runtime service in a project workspace
POST
/api/projects/{id}/workspaces/{workspaceId}/runtime-services/{action}Personal API keyAgent API keyConsole session
Control a runtime service in a project workspace.
Autorización
Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Cómo funcionan las claves.
Parámetros de ruta
idstringObligatorioThe project's id.
workspaceIdstringObligatorioThe workspace's id.
actionstringObligatorioThe action's id.
Cuerpo de la solicitud
application/json · obligatorio
workspaceCommandIdstring | nullOpcional
at least 1 characterruntimeServiceIdstring (uuid) | nullOpcional
serviceIndexinteger | nullOpcional
≥ 0Respuestas
200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation.
details names each field that failed.401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.