staqlydocs
REST APIAPI referenceChannels

Check the stored credentials against the platform

Check the stored credentials against the platform (channels:manage)

Every request sends Authorization: Bearer ...: the access token in local mode, an API key stk_... in cloud mode. Use Send to try it against your cloud instance with your API key.

POST
/v1/channels/{id}/test

Rate-limited per principal (burst 5, then 10 per minute). A failing check marks the channel needs_reconnect; a passing one clears it.

Authorization

headerAuthorizationBearer <token>

API key (stk_...), or in the Community Edition the access token (stk_local_...)

Path Parameters

id*string

Header Parameters

Idempotency-Key?string

Replays the stored response when the same key is repeated with the same method, path, query string and body within 24 hours (422 idempotency_mismatch with a different request, 409 idempotency_in_progress while the first one runs). Not applied to multipart uploads or to responses that carry a secret.

Lengthlength <= 200

Response Body

Result of the check (platform errors are reported, not raised)

application/json
  1. response
ok*boolean
error?string
profile?

What the platform knows the account as (handle, name, avatar_url, profile_url)

curl -X POST 'https://staqly.example.com/v1/channels/string/test'
{  "ok": true,  "error": "string",  "profile": {}}