Skip to main content
POST
Test credentials without saving them

Authorizations

X-API-Key
string
header
required

Body

application/json

Ad-hoc credentials test request. Verifies a credentials payload against the target platform without saving a credential — the "test before save" flow posts this body, then persists via POST /credentials on success.

platform_id
string
required
auth_method
enum<string>
required
Available options:
basic_auth,
api_key,
jwt,
oauth2,
aws_access_key
credentials
Credentials · object
required
service_id
string | null

Response

Successful Response

Result of a credential test. Returned with HTTP 200 for every test outcome, including failures and timeouts — inspect success and error rather than the status code. When success is false, error is one of: AUTH_FAILED, NETWORK, TIMEOUT, RATE_LIMITED, PERMISSION_DENIED, INVALID_CREDENTIALS_SHAPE, UNKNOWN. latency_ms measures the platform round-trip only.

success
boolean
required
error
string | null
required
details
string
required
latency_ms
integer
required
tested_at
string<date-time>
required