Dokploy
Generated

Destination

POST
/destination.create

Destination create

/destination.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

provider
Required
string | null

accessKey
Required
string

bucket
Required
string

region
Required
string

endpoint
Required
string

secretAccessKey
Required
string

serverIdstring

curl -X POST "https://your-dokploy-instance.com/api/destination.create" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "provider": "string",
    "accessKey": "string",
    "bucket": "string",
    "region": "string",
    "endpoint": "string",
    "secretAccessKey": "string",
    "serverId": "string"
  }'

Successful response

{}

POST
/destination.testConnection

Destination test Connection

/destination.testConnection

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

provider
Required
string | null

accessKey
Required
string

bucket
Required
string

region
Required
string

endpoint
Required
string

secretAccessKey
Required
string

serverIdstring

curl -X POST "https://your-dokploy-instance.com/api/destination.testConnection" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "provider": "string",
    "accessKey": "string",
    "bucket": "string",
    "region": "string",
    "endpoint": "string",
    "secretAccessKey": "string",
    "serverId": "string"
  }'

Successful response

{}

GET
/destination.one

Destination one

/destination.one

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Query Parameters

destinationId
Required
string

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

Successful response

{}

GET
/destination.all

Destination all

/destination.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/destination.all" \
  -H "Authorization: <token>"

Successful response

{}

POST
/destination.remove

Destination remove

/destination.remove

The Authorization access token

Authorization

Authorization<token>

API key authentication using Authorization header

In: header

Request Body

application/jsonRequired

destinationId
Required
string

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

Successful response

{}

POST
/destination.update

Destination update

/destination.update

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

accessKey
Required
string

bucket
Required
string

region
Required
string

endpoint
Required
string

secretAccessKey
Required
string

destinationId
Required
string

provider
Required
string | null

serverIdstring

curl -X POST "https://your-dokploy-instance.com/api/destination.update" \
  -H "Authorization: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "accessKey": "string",
    "bucket": "string",
    "region": "string",
    "endpoint": "string",
    "secretAccessKey": "string",
    "destinationId": "string",
    "provider": "string",
    "serverId": "string"
  }'

Successful response

{}

Previous

Deployment

Next

Docker