Skip to content

Check destination reachability (pre-create)

POST
/v1/destinations/check

A pre-create reachability probe (dry-run — nothing is persisted). Checks a URL BEFORE the destination exists, so a client can gate creation on it. For sqs it runs the live GetQueueAttributes probe (ambient cross-account credentials); for https it runs an SSRF-gated HEAD/GET connect — reachable = DNS resolves + TCP/TLS connects + the server returns ANY HTTP status (401/403/404/405/5xx included); not reachable only on DNS failure, connection refused, TLS error, or timeout (with a human detail). pull is always { "ok": true }. A not-yet-deliverable broker type returns { "ok": false, "detail": "<type> delivery isn't supported yet" }.

Authorizations

apiKey

Scoped API key. Scopes are readwriteadmin. A call needing more scope than the key holds returns 403 insufficient_scope.

Type
HTTP (bearer)

Request Body

application/json
JSON
{
  
"type": "string",
  
"url": "https://sqs.us-east-1.amazonaws.com/123456789012/orders"
}

Responses

The reachability verdict.

application/json
JSON
{
  
"ok": true,
  
"detail": "string"
}

Playground

Authorization
Body

Samples

Powered by VitePress OpenAPI

Emithook · a Finnoto product