Skip to Content
veriom

Discover connector resources

Before an install, list what a pasted key can see and the values it determines. The key is used for this request only and never stored.

POST
/v1/workspaces/{workspace_id}/connector-discovery/{definition_key}

Before an install, list what a pasted key can see and the values it determines.

The key is used for this request only and never stored.

Authorization

workspaceToken
headerAuthorizationBearer <vat_<opaque-token>>

Expiring, hashed workspace token with explicit scopes.

Path Parameters

workspace_id*Workspace Id
Formatuuid
definition_key*Definition Key

Request Body

application/json
  1. body
auth_mode?Auth Mode
Length2 <= length <= 32
Default"api_token"
config?

base_url for a pasted site or self-hosted Sentry; project_slug for CircleCI.

credentials?

Used for this request only and never stored.

Response Body

Successful Response

application/json
  1. response
all_selected?All Selected

Nothing narrows the selection: every readable item syncs.

Defaultfalse
definition_key*Definition Key
derived?

Setup values the pasted credential determines, to send with the install (Datadog base_url; CircleCI org_id and project_id).

field?|

The setup config field selected.

items?array<>
kind?|

What the items are, such as jira_projects; null if none.

multiple?Multiple

Many items may be selected, and none selected means every readable one.

Defaultfalse
sites?array<>

Atlassian sites this connection's grant covers; one is selected.

Example Request
curl -X POST 'https://api.veriom.ai/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/connector-discovery/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "all_selected": false,  "definition_key": "string",  "derived": {},  "field": "string",  "items": [    {      "active_at": "2019-08-24T14:15:22Z",      "detail": "string",      "id": "string",      "name": "string",      "selected": true,      "suggested": true    }  ],  "kind": "string",  "multiple": false,  "sites": [    {      "active_at": "2019-08-24T14:15:22Z",      "detail": "string",      "id": "string",      "name": "string",      "selected": true,      "suggested": true    }  ]}