Skip to content

Test the credential already stored for a broker connection, changing

POST
/admin/broker-connections/{code}/credentials/test
curl --request POST \
--url http://localhost:3001/admin/broker-connections/string/credentials/test \
--header 'Authorization: Bearer <token>'

Nothing. Distinct from the save path’s pre-write test: this one exists so an operator can re-check a credential that is already live (e.g. after a broker-side key rotation) without resubmitting it.

code
required
string

Broker connection code

Test outcome for the stored credential

Media typeapplication/json

Response body for POST .../credentials/test.

object
message

Present on anything short of a clean pass: the broker’s rejection reason, or why nothing was attempted. Never derived from submitted input — see TestOutcome’s own doc comment.

string
nullable
ok
required

Only meaningful when tested is true: whether it passed.

boolean
tested
required

Whether a check was actually attempted — false for FIX.

boolean

Example generated

{
"message": "example",
"ok": true,
"tested": true
}

No credential is stored for this connection

Not found

The credential store could not be read, or the stored credential could not be decrypted