Skip to Content
veriom

Test connector installation

POST
/v1/workspaces/{workspace_id}/connector-installations/{installation_id}/test

Authorization

workspaceToken
headerAuthorizationBearer <vat_<opaque-token>>

Expiring, hashed workspace token with explicit scopes.

Path Parameters

workspace_id*Workspace Id
Formatuuid
installation_id*Installation Id
Formatuuid

Response Body

Successful Response

application/json
  1. response
auth_mode*Auth Mode
checkpoint*
circuit_open_until*|null
config*
consecutive_failures*Consecutive Failures
created_at*Created At
Formatdate-time
credential_configured*Credential Configured
credential_version*Credential Version
cursor*string|null
definition_key*Definition Key
display_name*Display Name
id*Id
Formatuuid
installed_by*Installed By
Formatuuid
last_error_category*string|null
last_error_code*string|null
last_synced_at*|null
last_tested_at*|null
next_sync_at*|null
owner_user_id*|null
paused_at*|null
revision*Revision
revoked_at*|null
scopes*array<string>
status*Status
updated_at*Updated At
Formatdate-time
workspace_id*Workspace Id
Formatuuid
Example Request
curl -X POST 'https://api.veriom.ai/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/connector-installations/497f6eca-6276-4993-bfeb-53cbbbba6f08/test'
Example Response
{  "auth_mode": "string",  "checkpoint": {},  "circuit_open_until": "2019-08-24T14:15:22Z",  "config": {},  "consecutive_failures": 0,  "created_at": "2019-08-24T14:15:22Z",  "credential_configured": true,  "credential_version": 0,  "cursor": "string",  "definition_key": "string",  "display_name": "string",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "installed_by": "7ce86621-e8ba-4173-a3a1-53b48ad3100c",  "last_error_category": "string",  "last_error_code": "string",  "last_synced_at": "2019-08-24T14:15:22Z",  "last_tested_at": "2019-08-24T14:15:22Z",  "next_sync_at": "2019-08-24T14:15:22Z",  "owner_user_id": "65139110-7c3c-4777-b692-80c218be3b9d",  "paused_at": "2019-08-24T14:15:22Z",  "revision": 0,  "revoked_at": "2019-08-24T14:15:22Z",  "scopes": [    "string"  ],  "status": "string",  "updated_at": "2019-08-24T14:15:22Z",  "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"}