Get SSH access credentials for an environment

GET

/api/v3/organizations/{organisation}/applications/{application}/environments/{environment}/ssh-access

curl --request GET \
  --url https://dashboard.quantcdn.io/api/v3/organizations/test-org/applications/test-app/environments/test-env/ssh-access \
  --header 'Authorization: Bearer <token>'

• QuantCDN Public Cloud
• QuantGov Cloud

Authorizations

• BearerAuth

Parameters

Path Parameters

organisation

required

string

The organisation ID

Example

test-org

application

required

string

The application ID

Example

test-app

environment

required

string

The environment ID

Example

test-env

Responses

200

SSH access credentials

Media typeapplication/json

object

success

boolean

credentials

object

accessKeyId

string

secretAccessKey

string

sessionToken

string

expiration

string format: date-time

clusterName

string

taskArn

string

taskId

string

containerNames

Array<string>

region

string

expiresIn

integer

organizationScope

string

Example^generated

{
  "success": true,
  "credentials": {
    "accessKeyId": "example",
    "secretAccessKey": "example",
    "sessionToken": "example",
    "expiration": "2026-04-15T12:00:00Z"
  },
  "clusterName": "example",
  "taskArn": "example",
  "taskId": "example",
  "containerNames": [
    "example"
  ],
  "region": "example",
  "expiresIn": 1,
  "organizationScope": "example"
}

403

Insufficient permissions

404

Environment not found

500

Failed to generate SSH access credentials