Skip to content

Get SSH access credentials for an environment

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

Authorizations

Parameters

Path Parameters

organisation
required
string

The organisation machine name

application
required
string

The application name

environment
required
string

The environment name

Responses

200

SSH access credentials

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

403

Insufficient permissions

404

Environment not found

500

Failed to generate SSH access credentials