Cloady Docs
API ReferenceEndpointsApplications

Create a short-lived SSH session credential for a running container

POST
/api/workspaces/{workspaceSlug}/apps/{appSlug}/ssh/session
AuthorizationBearer <token>

Personal API token (cldy_…)

In: header

Path Parameters

workspaceSlug*string
appSlug*string

Query Parameters

env?string

Value in

  • "production"
  • "preview"
  • "development"
region?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/workspaces/string/apps/string/ssh/session" \  -H "Content-Type: application/json" \  -d '{    "component": "string"  }'
{  "host": "string",  "port": 0,  "wsUrl": "string",  "username": "string",  "password": "string"}