Dokploy
Generated

Ssh Key

POST
/sshKey.create

Ssh Key create

/sshKey.create

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

name
Required
string

Minimum length: 1

descriptionstring | null

privateKey
Required
string

publicKey
Required
string

organizationId
Required
string

curl -X POST "https://your-dokploy-instance.com/api/sshKey.create" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "privateKey": "string",
    "publicKey": "string",
    "organizationId": "string"
  }'

Successful response

{}

POST
/sshKey.remove

Ssh Key remove

/sshKey.remove

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

sshKeyId
Required
string

curl -X POST "https://your-dokploy-instance.com/api/sshKey.remove" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "sshKeyId": "string"
  }'

Successful response

{}

GET
/sshKey.one

Ssh Key one

/sshKey.one

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Query Parameters

sshKeyId
Required
string

curl -X GET "https://your-dokploy-instance.com/api/sshKey.one?sshKeyId=string" \
  -H "Authorization: <token>"

Successful response

{}

GET
/sshKey.all

Ssh Key all

/sshKey.all

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

curl -X GET "https://your-dokploy-instance.com/api/sshKey.all" \
  -H "Authorization: <token>"

Successful response

{}

POST
/sshKey.generate

Ssh Key generate

/sshKey.generate

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

typestring

Value in: "rsa" | "ed25519"
curl -X POST "https://your-dokploy-instance.com/api/sshKey.generate" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "rsa"
  }'

Successful response

{}

POST
/sshKey.update

Ssh Key update

/sshKey.update

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

namestring

Minimum length: 1

descriptionstring | null

lastUsedAtstring | null

sshKeyId
Required
string

curl -X POST "https://your-dokploy-instance.com/api/sshKey.update" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "lastUsedAt": "string",
    "sshKeyId": "string"
  }'

Successful response

{}

Previous

Settings

Next

Stripe