CloudCLI API Documentation
CloudCLI Documentation
  1. Environments
  • CloudCLI API Documentation
  • Environments
    • List environments
      GET
    • Get environment
      GET
    • Create environment
      POST
    • Delete environment
      DELETE
    • Get SSH credentials
      GET
    • Start environment
      POST
    • Stop environment
      POST
  • Agents
    • Execute AI agent
      POST
    • AI Agent models
      GET
  • Schemas
    • Schemas
      • AgentModels
      • Environment
      • CreateEnvironmentRequest
      • SSHCredentials
      • AgentExecuteRequest
      • Error
  1. Environments

Get SSH credentials

GET
https://cloudcli.ai/api/v1/environments/{id}/credentials
Retrieve the credentials needed to SSH into a running CloudCLI environment. Returns a ready-to-paste ssh_command, plus the individual pieces (username, password, host, port) so you can wire them into your IDE, SFTP client, or connection manager of choice.

Request

Authorization
API Key
Add parameter in header
X-API-KEY
Example:
X-API-KEY: ********************
or
Path Params

Responses

🟢200OK
application/json
Credentials retrieved successfully
Body

🟠404Not Found
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://cloudcli.ai/api/v1/environments//credentials' \
--header 'X-API-KEY: <api-key>'
Response Response Example
200 - Example 1
{
    "username": "mybackend-abc123",
    "password": "generated_password",
    "ssh_command": "ssh mybackend-abc123@ssh.cloudcli.ai",
    "access_url": "https://mybackend-abc123.cloudcli.ai"
}
Modified at 2026-04-24 15:36:40
Previous
Delete environment
Next
Start environment
Built with