Create Site SSH Access

POST

https://api.servebolt.io/v1/environments/{id}/ssh-access

Grant SSH access to a site for an SSH key.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

string

required

Header Params

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

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.servebolt.io/v1/environments//ssh-access' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-raw '{
    "data": {
        "attributes": {
            "sshkey_id": 82,
            "expiration": 3600
        }
    }
}'

Responses

🟢201Created

application/json

Body

data

object

required

integer

required

type

string

required

attributes

object

required

Example

{
    "data": {
        "id": 0,
        "type": "string",
        "attributes": {
            "sshkey_id": 0,
            "vhost_id": 0,
            "status": null,
            "expires_at": "string",
            "enabled": 0,
            "sshkeyEnabled": true,
            "fingerprint": "string",
            "reason": "string",
            "customer": "string"
        }
    }
}

🟠422Parameter Error

Modified at 2025-06-25 09:04:41

Get Site SSH Accesses

Remove Site SSH Access