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 code	Description
`200`	Successful response
`default`	Error 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 code	Description
`200`	Successful response
`default`	Error 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 code	Description
`200`	Successful response
`default`	Error 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 code	Description
`200`	Successful response
`default`	Error 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 code	Description
`200`	Successful response
`default`	Error 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 code	Description
`200`	Successful response
`default`	Error 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"
    }
  ]
}

destination

POST/destination.create

AuthorizationRequiredBearer <token>

nameRequiredstring

accessKeyRequiredstring

bucketRequiredstring

regionRequiredstring

endpointRequiredstring

secretAccessKeyRequiredstring

Response

Typescript

POST/destination.testConnection

AuthorizationRequiredBearer <token>

nameRequiredstring

accessKeyRequiredstring

bucketRequiredstring

regionRequiredstring

endpointRequiredstring

secretAccessKeyRequiredstring

Response

Typescript

GET/destination.one

AuthorizationRequiredBearer <token>

destinationIdRequiredstring

Response

Typescript

GET/destination.all

AuthorizationRequiredBearer <token>

Response

Typescript

POST/destination.remove

AuthorizationRequiredBearer <token>

destinationIdRequiredstring

Response

Typescript

POST/destination.update

AuthorizationRequiredBearer <token>

nameRequiredstring

accessKeyRequiredstring

bucketRequiredstring

regionRequiredstring

endpointRequiredstring

secretAccessKeyRequiredstring

destinationIdRequiredstring

Response

Typescript

On this page

POST`/destination.create`

`Authorization`
Required
Bearer <token>

`name`
Required
string

`accessKey`
Required
string

`bucket`
Required
string

`region`
Required
string

`endpoint`
Required
string

`secretAccessKey`
Required
string

POST`/destination.testConnection`

`Authorization`
Required
Bearer <token>

`name`
Required
string

`accessKey`
Required
string

`bucket`
Required
string

`region`
Required
string

`endpoint`
Required
string

`secretAccessKey`
Required
string

GET`/destination.one`

`Authorization`
Required
Bearer <token>

`destinationId`
Required
string

GET`/destination.all`

`Authorization`
Required
Bearer <token>

POST`/destination.remove`

`Authorization`
Required
Bearer <token>

`destinationId`
Required
string

POST`/destination.update`

`Authorization`
Required
Bearer <token>

`name`
Required
string

`accessKey`
Required
string

`bucket`
Required
string

`region`
Required
string

`endpoint`
Required
string

`secretAccessKey`
Required
string

`destinationId`
Required
string