API referenceAdmin provider gateways
Probe a gateway connection without storing it
Calls the gateway with a token, and reports what it answered. Nothing is stored, and no other endpoint runs this check: a write stores what it is given. Unlike the providers API, a refused token is reported as reason: rejected rather than raised as provider_key_invalid, because the same 401 means both a wrong token and a gateway that is not finished being set up.
agw_identity_auth.session_token<token>
The console's session cookie. Admin requests from the console also send x-console-request: 1.
In: cookie
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/admin/provider-gateways/test" \ -H "Content-Type: application/json" \ -d '{ "type": "cf_aig", "accountId": "string", "gatewayId": "string", "token": "string" }'{ "validated": true, "reason": "no_probe", "status": 0}