Skip to Content
veriom

Connector preflight

POST
/v1/workspaces/{workspace_id}/connector-installations/preflight

Authorization

workspaceToken
headerAuthorizationBearer <vat_<opaque-token>>

Expiring, hashed workspace token with explicit scopes.

Path Parameters

workspace_id*Workspace Id
Formatuuid

Request Body

application/json
  1. body
auth_mode*Auth Mode
Length2 <= length <= 32
config?
credentials?
definition_key*Definition Key
Match^[a-z0-9][a-z0-9_-]{1,63}$
display_name*Display Name
Length2 <= length <= 255
scopes?array<string>
Itemsitems <= 100
verify_connectivity?Verify Connectivity
Defaulttrue

Response Body

Successful Response

application/json
  1. response
granted_scopes*array<string>
normalized_config*
ok*Ok
verification*Verification
Value in"configuration""connectivity"
warnings?array<string>
Example Request
curl -X POST 'https://api.veriom.ai/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/connector-installations/preflight' \  -H 'Content-Type: application/json' \  -d '{  "auth_mode": "string",  "definition_key": "string",  "display_name": "string"}'
Example Response
{  "granted_scopes": [    "string"  ],  "normalized_config": {},  "ok": true,  "verification": "configuration",  "warnings": [    "string"  ]}