Write a small object under a destination's prefix with its own credentials: it's ready once one passes since it last changed
POST
/v1/buyer/destinations/{id}/test
const url = 'https://example.com/v1/buyer/destinations/example/test';const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/v1/buyer/destinations/example/test \ --header 'Authorization: Bearer <token>'Who: a workspace’s owner. Not for API keys.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string
Responses
Section titled “Responses”OK
Media typeapplication/json
object
destination
required
object
created_at
required
string format: date-time
created_by
required
gcs
required
id
required
integer format: int64
kind
required
string | null
name
required
string
ready
required
boolean
s3
required
schedules
required
integer format: int32
sealed
required
Array<object>
object
last4
required
string
name
required
string
set
required
boolean
updated_at
required
string | null format: date-time
sequence
required
integer format: int64
test_error
required
string
tested_at
required
string | null format: date-time
uncompressed
required
boolean
updated_at
required
string format: date-time
updated_by
required
workspace_id
required
integer format: int64
error_code
required
string
error_message
required
string
ok
required
boolean
Example
{ "destination": { "created_by": { "kind": "user" }, "kind": "s3", "updated_by": { "kind": "user" } }}default
Section titled “default”An error, as go-commons apperr maps it
Media typeapplication/json
object
error
required
object
code
required
string
fields
object
key
additional properties
string
message
required
string
Example generated
{ "error": { "code": "example", "fields": { "additionalProperty": "example" }, "message": "example" }}