La referencia de la API se publica en inglés.
Prepare, enable, or remove a Railway container SSH key
POST
/api/tool-connections/{connectionId}/railway/sshPersonal API keyAgent API keyConsole session
Prepare, enable, or remove a Railway container SSH key.
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
connectionIdstringObligatorioThe connection's id.
Cuerpo de la solicitud
application/json · obligatorio
actionstringObligatorioWhich kind of object this is; it decides which other fields apply.
one of: "prepare", "enable", "remove"grantIdstring (uuid)Obligatorio
knownHostsstringOpcionalRequired with action: "enable".
1–8192 charactersRespuestas
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.
409ConflictThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).
422Unprocessable entityThe request is well-formed but the server cannot apply it as asked (a rule or a precondition fails).
Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.