Dokploy

destination

POST/destination.create

destination-create

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

name
Required
string

Minimum length: 1

accessKey
Required
string

bucket
Required
string

region
Required
string

endpoint
Required
string

secretAccessKey
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/destination.create" \
  -d '{
  "name": "string",
  "accessKey": "string",
  "bucket": "string",
  "region": "string",
  "endpoint": "string",
  "secretAccessKey": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/destination.testConnection

destination-testConnection

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

name
Required
string

Minimum length: 1

accessKey
Required
string

bucket
Required
string

region
Required
string

endpoint
Required
string

secretAccessKey
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/destination.testConnection" \
  -d '{
  "name": "string",
  "accessKey": "string",
  "bucket": "string",
  "region": "string",
  "endpoint": "string",
  "secretAccessKey": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/destination.one

destination-one

Authorization

Authorization
Required
Bearer <token>

In: header

Query Parameters

destinationId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/destination.one?destinationId=string"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

GET/destination.all

destination-all

Authorization

Authorization
Required
Bearer <token>

In: header

Status codeDescription
200Successful response
defaultError response
curl -X GET "http://localhost:3000/api/destination.all"

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/destination.remove

destination-remove

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

destinationId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/destination.remove" \
  -d '{
  "destinationId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

POST/destination.update

destination-update

Authorization

Authorization
Required
Bearer <token>

In: header

Request Body

name
Required
string

Minimum length: 1

accessKey
Required
string

bucket
Required
string

region
Required
string

endpoint
Required
string

secretAccessKey
Required
string

destinationId
Required
string

Status codeDescription
200Successful response
defaultError response
curl -X POST "http://localhost:3000/api/destination.update" \
  -d '{
  "name": "string",
  "accessKey": "string",
  "bucket": "string",
  "region": "string",
  "endpoint": "string",
  "secretAccessKey": "string",
  "destinationId": "string"
}'

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

On this page