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

Header Params

Body Params application/json

Example

{
    "data": {
        "attributes": {
            "sshkey_id": 82,
            "expiration": 3600
        }
    }
}

Request Code 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 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "data": {
        "attributes": {
            "sshkey_id": 82,
            "expiration": 3600
        }
    }
}'

Responses

🟠422Parameter Error

application/json

Body

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"
            }
        }
    ]
}

🟢201Created

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

Get Site SSH Accesses

Remove Site SSH Access