Create Environment SSH Access
POST
/v1/environments/{id}/ssh-accessGrant SSH access to an environment for an SSH key.
Request
Path Params
id
string
required
Header Params
Accept
string
required
Example:
application/json
Content-Type
string
required
Example:
application/json
Body Params application/json
data
object
required
attributes
object
required
Example
{
"data": {
"attributes": {
"sshkey_id": 82,
"expiration": 3600
}
}
}
Request samples
Responses
Parameter Error(422)
Created(201)
HTTP Code: 422
Content Type : JSONapplication/json
Data Schema
errors
array [object {4}]
required
title
string
required
detail
string
required
code
integer
required
source
object
required
Example
{
"errors": [
{
"title": "Invalid input",
"detail": "The data.attributes.expiration field is required.",
"code": 422,
"source": {
"pointer": "/data/attributes/expiration"
}
},
{
"title": "Invalid input",
"detail": "The data.attributes.sshkey id field is required.",
"code": 422,
"source": {
"pointer": "/data/attributes/sshkey_id"
}
}
]
}
Last modified: 6 months ago