Sign inGet an API key

Test destination

Uploads a small probe object to the given path with the stored credentials, so a misconfigured bucket is found here rather than on a real task.

POST/destinations/{id}/test
AuthAPI keyorOAuth tokenHow to send it

Uploads a small WEBP probe to path with the credentials on file and answers 204. Call it after creating a destination or rotating its secret: a wrong key or a missing permission shows up here as 502 DESTINATION_TEST_FAILED, not on a generation you already paid for. Delete the probe afterwards.

Path parameters#

idstringrequired

The destination to test.

e.g. "dst_01KE7XWWEQ4MCGWKBQKJ1G47RP"

Request body#

pathstringrequired

Destination path for the test upload. Used verbatim, not templated.

≥ 1 characters≤ 2048 characters

Response#

204Destination test completed

No body.

Errors#

A failed call names what went wrong in code, with a sentence in message. The codes, which of them are worth retrying, and how to read a validation failure are on Errors.