Authorize SSH key for cPanel account

Authorize an SSH key for a specific hosting account. This is useful when you want to grant secure access to your cPanel account via SSH to manage files or run scripts.

Web Hosting Services Hosting Accounts

Context

Where to get IDs / values

path.accountId

GET /api/hosting-accounts

Related endpoints

POST /api/hosting/{accountId}/ssh-keys Manage SSH keys for your web hosting account. GET /api/hosting/{accountId}/ssh-keys Retrieve SSH keys for your web hosting account. GET /api/hosting/{accountId}/php Get and display available PHP versions for hosting

Path Parameters

accountId integer · min: 1 required Example: 20000

Unique account identifier

Headers

Accept Example

Content-Type Example

Body

required

application/json

name string required · Example: DemoKey

Responses

200

data object required

data.accountId string required · Example: 20000

data.authorized boolean required · Example: true

data.cpanelUsername string required · Example: xkqjm

data.name string required · Example: DemoKey

data.success boolean required · Example: true

True for successful responses.

requestId string required · Example: 2121ae20-bd9d-41e9-aeeb-5dd1dd1a24ba

Unique request identifier (UUID).

success boolean required · Example: true

True for successful responses.

timestamp string required · Example: 2026-02-10T00:00:00.000Z

ISO 8601 timestamp (UTC).

500

code string required · Example: INTERNAL_ERROR

Machine-readable error code.

error string required · Example: Internal Server Error

HTTP status title (e.g. 'Bad Request').

message string required · Example: An unexpected error occurred

Human-readable message.

requestId string required · Example: 2121ae20-bd9d-41e9-aeeb-5dd1dd1a24ba

Unique request identifier (UUID).

timestamp string required · Example: 2026-02-10T00:00:00.000Z

ISO 8601 timestamp (UTC).

POST https://cloud.hostup.se/api/hosting/{accountId}/ssh-keys/authorize

For AI assistants

cURL

curl -X POST "https://cloud.hostup.se/api/hosting/20000/ssh-keys/authorize" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "DemoKey"
  }'

Response

{
  "success": true,
  "timestamp": "2026-02-10T00:00:00.000Z",
  "requestId": "2121ae20-bd9d-41e9-aeeb-5dd1dd1a24ba",
  "data": {
    "success": true,
    "accountId": "20000",
    "cpanelUsername": "xkqjm",
    "name": "DemoKey",
    "authorized": true
  }
}

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "accountId": {
          "type": "string"
        },
        "authorized": {
          "type": "boolean"
        },
        "cpanelUsername": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "success": {
          "type": "boolean",
          "description": "True for successful responses."
        }
      }
    },
    "requestId": {
      "type": "string",
      "description": "Unique request identifier (UUID)."
    },
    "success": {
      "type": "boolean",
      "description": "True for successful responses."
    },
    "timestamp": {
      "type": "string",
      "description": "ISO 8601 timestamp (UTC)."
    }
  }
}

Request Body Example 1

{
  "name": "DemoKey"
}