Skip to main content
POST
Test a custom API source

Authorizations

Authorization
string
header
required

JWT authentication token

Headers

Idempotency-Key
string

Optional key that makes a repeated request return the same job instead of starting another one. Without it, Neo derives a key from the source's configuration (a new manual synchronization gets a new key).

Required string length: 1 - 200

Path Parameters

id
string<uuid>
required

Source id

Body

application/json
credential
object

Write-only credential bundle. Fill the fields the authentication type needs: api_key (header or query API key), token (bearer), username and password (basic), client_id and client_secret (OAuth client credentials).

Response

Test job accepted

job_id
string<uuid>
required
credential_configured
boolean

Returned by the test action. True when the source has a stored credential.