addConnectorToTenant
curl --request POST \
--url https://api.askparable.com/api/connectors \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"authenticationConfig": {},
"authenticationStrategyId": "<string>",
"connectorId": "<string>",
"groupingId": "<string>",
"ingestionConfig": {},
"idempotencyKey": "<string>",
"name": "<string>"
}
'import requests
url = "https://api.askparable.com/api/connectors"
payload = {
"authenticationConfig": {},
"authenticationStrategyId": "<string>",
"connectorId": "<string>",
"groupingId": "<string>",
"ingestionConfig": {},
"idempotencyKey": "<string>",
"name": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
authenticationConfig: {},
authenticationStrategyId: '<string>',
connectorId: '<string>',
groupingId: '<string>',
ingestionConfig: {},
idempotencyKey: '<string>',
name: '<string>'
})
};
fetch('https://api.askparable.com/api/connectors', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.askparable.com/api/connectors"
payload := strings.NewReader("{\n \"authenticationConfig\": {},\n \"authenticationStrategyId\": \"<string>\",\n \"connectorId\": \"<string>\",\n \"groupingId\": \"<string>\",\n \"ingestionConfig\": {},\n \"idempotencyKey\": \"<string>\",\n \"name\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": {
"authenticationConfig": {},
"authenticationStrategy": {
"createdAt": "<string>",
"createdBy": "<string>",
"id": "<string>",
"updatedAt": "<string>",
"updatedBy": "<string>",
"addressingConfig": {
"basePath": "<string>",
"host": "<string>",
"scheme": "<string>",
"variables": [
{
"name": "<string>",
"source": "<string>",
"oauthResponsePath": "<string>",
"required": true
}
]
},
"apiKeyConfig": {
"headerName": "<string>",
"queryParam": "<string>"
},
"basicConfig": {
"passwordField": "<string>",
"usernameField": "<string>",
"passwordValue": "<string>"
},
"bearerConfig": {
"headerName": "<string>",
"tokenField": "<string>",
"tokenPrefix": "<string>"
},
"configSchema": {},
"defaultBaseUrl": "<string>",
"defaultScopes": [
"<string>"
],
"delegatedUserField": "<string>",
"docs": "<string>",
"extraHeaders": {},
"hook": "<string>",
"ingestionConfigSchema": {},
"label": "<string>",
"oauth2Config": {
"tokenEndpoint": "<string>",
"audienceParam": "<string>",
"authorizeUrl": "<string>",
"passwordField": "<string>",
"scopes": [
"<string>"
],
"tokenEndpointExtraParams": {},
"tokenPrefix": "<string>",
"tokenRefreshCodes": [
123
],
"tokenResponsePath": "<string>",
"usernameField": "<string>"
},
"preEncodedBasicConfig": {
"tokenField": "<string>"
}
},
"createdAt": "<string>",
"credentialMetadataId": "<string>",
"id": "<string>",
"ingestionConfig": {},
"message": "<string>",
"success": true,
"tenant": {
"createdAt": "<string>",
"createdBy": "<string>",
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"updatedAt": "<string>",
"updatedBy": "<string>",
"logo": {}
},
"name": "<string>"
},
"meta": {
"requestId": "<string>",
"totalCount": 123
},
"links": {
"first": "<string>",
"last": "<string>",
"next": "<string>",
"prev": "<string>"
}
}{
"error": "<string>"
}{
"error": "<string>"
}addConnectorToTenant
POST /api/connectors Add a connector to this workspace with initial configuration
POST
/
api
/
connectors
addConnectorToTenant
curl --request POST \
--url https://api.askparable.com/api/connectors \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"authenticationConfig": {},
"authenticationStrategyId": "<string>",
"connectorId": "<string>",
"groupingId": "<string>",
"ingestionConfig": {},
"idempotencyKey": "<string>",
"name": "<string>"
}
'import requests
url = "https://api.askparable.com/api/connectors"
payload = {
"authenticationConfig": {},
"authenticationStrategyId": "<string>",
"connectorId": "<string>",
"groupingId": "<string>",
"ingestionConfig": {},
"idempotencyKey": "<string>",
"name": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
authenticationConfig: {},
authenticationStrategyId: '<string>',
connectorId: '<string>',
groupingId: '<string>',
ingestionConfig: {},
idempotencyKey: '<string>',
name: '<string>'
})
};
fetch('https://api.askparable.com/api/connectors', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.askparable.com/api/connectors"
payload := strings.NewReader("{\n \"authenticationConfig\": {},\n \"authenticationStrategyId\": \"<string>\",\n \"connectorId\": \"<string>\",\n \"groupingId\": \"<string>\",\n \"ingestionConfig\": {},\n \"idempotencyKey\": \"<string>\",\n \"name\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"data": {
"authenticationConfig": {},
"authenticationStrategy": {
"createdAt": "<string>",
"createdBy": "<string>",
"id": "<string>",
"updatedAt": "<string>",
"updatedBy": "<string>",
"addressingConfig": {
"basePath": "<string>",
"host": "<string>",
"scheme": "<string>",
"variables": [
{
"name": "<string>",
"source": "<string>",
"oauthResponsePath": "<string>",
"required": true
}
]
},
"apiKeyConfig": {
"headerName": "<string>",
"queryParam": "<string>"
},
"basicConfig": {
"passwordField": "<string>",
"usernameField": "<string>",
"passwordValue": "<string>"
},
"bearerConfig": {
"headerName": "<string>",
"tokenField": "<string>",
"tokenPrefix": "<string>"
},
"configSchema": {},
"defaultBaseUrl": "<string>",
"defaultScopes": [
"<string>"
],
"delegatedUserField": "<string>",
"docs": "<string>",
"extraHeaders": {},
"hook": "<string>",
"ingestionConfigSchema": {},
"label": "<string>",
"oauth2Config": {
"tokenEndpoint": "<string>",
"audienceParam": "<string>",
"authorizeUrl": "<string>",
"passwordField": "<string>",
"scopes": [
"<string>"
],
"tokenEndpointExtraParams": {},
"tokenPrefix": "<string>",
"tokenRefreshCodes": [
123
],
"tokenResponsePath": "<string>",
"usernameField": "<string>"
},
"preEncodedBasicConfig": {
"tokenField": "<string>"
}
},
"createdAt": "<string>",
"credentialMetadataId": "<string>",
"id": "<string>",
"ingestionConfig": {},
"message": "<string>",
"success": true,
"tenant": {
"createdAt": "<string>",
"createdBy": "<string>",
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"updatedAt": "<string>",
"updatedBy": "<string>",
"logo": {}
},
"name": "<string>"
},
"meta": {
"requestId": "<string>",
"totalCount": 123
},
"links": {
"first": "<string>",
"last": "<string>",
"next": "<string>",
"prev": "<string>"
}
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Workspace slug. Overrides subdomain-based workspace resolution when provided.
Example:
"acme"
Optional request correlation ID echoed back in the response.
Example:
"550e8400-e29b-41d4-a716-446655440000"
Body
application/json
A Parable Schema in JSON
UUID v4 with automatic base62 encoding for client-facing APIs
UUID v4 with automatic base62 encoding for client-facing APIs
UUID v4 with automatic base62 encoding for client-facing APIs
A Parable Schema in JSON
An objects name
⌘I