import { WebApiSDK } from "@parable-platform/web-api-sdk";
import type { UpdateTenantConnectorTapInput } from "@parable-platform/web-api-types";
const sdk = new WebApiSDK({
baseUrl: process.env.PARABLE_API_URL!,
auth: { token: process.env.PARABLE_API_TOKEN! },
requestInterceptor: (config) => ({
...config,
headers: { ...config.headers, "X-Tenant": process.env.PARABLE_WORKSPACE! },
}),
});
const input: UpdateTenantConnectorTapInput = JSON.parse(`{}`);
const result = await sdk.tenantConnectorTaps.updateTenantConnectorTap(
"example",
input
);import json
import os
from parable_types_web_api import UpdateTenantConnectorTapInput
from parable_web_api_sdk import ClientConfig, WebApiSDK
sdk = WebApiSDK(
ClientConfig(
base_url=os.environ["PARABLE_API_URL"],
auth_token=os.environ["PARABLE_API_TOKEN"],
default_headers={"X-Tenant": os.environ["PARABLE_WORKSPACE"]},
)
)
input_data = UpdateTenantConnectorTapInput.model_validate(
json.loads("{}"),
)
result = sdk.tenant_connector_taps.update_tenant_connector_tap('example', input_data)use parable_web_api_sdk::{types, ClientConfig, RequestOptions, WebApiSdk};
let sdk = WebApiSdk::new(ClientConfig::with_base_url(
std::env::var("PARABLE_API_URL")?,
Some(std::env::var("PARABLE_API_TOKEN")?),
None,
))?;
let options = RequestOptions::with_header("X-Tenant", std::env::var("PARABLE_WORKSPACE")?, None, None);
let input: types::UpdateTenantConnectorTapInput = serde_json::from_value(
serde_json::json!({}),
)?;
let result = sdk.tenant_connector_taps.update_tenant_connector_tap(
serde_json::from_value(serde_json::json!("example"))?,
input,
Some(&options)
).await?;sdk, err := webapisdk.New(webapisdk.SDKConfig{
BaseURL: os.Getenv("PARABLE_API_URL"),
Auth: &webapisdk.AuthConfig{Token: os.Getenv("PARABLE_API_TOKEN")},
RequestInterceptor: func(ctx context.Context, req *http.Request) error {
req.Header.Set("X-Tenant", os.Getenv("PARABLE_WORKSPACE"))
return nil
},
})
if err != nil {
return err
}
var input webapitypes.UpdateTenantConnectorTapInput
if err := json.Unmarshal([]byte(`{}`), &input); err != nil {
return err
}
result, err := sdk.TenantConnectorTapsNamespace.UpdateTenantConnectorTap(ctx, "example", input){
"data": {
"canonicalPersonSource": true,
"connectorTapId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"enabled": true,
"id": "<string>",
"kind": "override",
"name": "<string>",
"outputSchema": {},
"tenantConnectorId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"artifactId": "<string>",
"config": {
"catalogSlug": "<string>",
"materializedDefault": true,
"selectedFields": [
"<string>"
],
"storageUri": "<string>",
"systemDisabled": true
},
"description": "<string>",
"enabledSince": "2023-11-07T05:31:56Z"
},
"meta": {
"requestId": "<string>",
"totalCount": 123
},
"links": {
"first": "<string>",
"last": "<string>",
"next": "<string>",
"prev": "<string>"
}
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}Change a Tap's settings
Updates the settings on an existing Tap. Which Provider connection it belongs to, which Provider Tap it came from, and a published Artifact’s table name and storage cannot be changed.
import { WebApiSDK } from "@parable-platform/web-api-sdk";
import type { UpdateTenantConnectorTapInput } from "@parable-platform/web-api-types";
const sdk = new WebApiSDK({
baseUrl: process.env.PARABLE_API_URL!,
auth: { token: process.env.PARABLE_API_TOKEN! },
requestInterceptor: (config) => ({
...config,
headers: { ...config.headers, "X-Tenant": process.env.PARABLE_WORKSPACE! },
}),
});
const input: UpdateTenantConnectorTapInput = JSON.parse(`{}`);
const result = await sdk.tenantConnectorTaps.updateTenantConnectorTap(
"example",
input
);import json
import os
from parable_types_web_api import UpdateTenantConnectorTapInput
from parable_web_api_sdk import ClientConfig, WebApiSDK
sdk = WebApiSDK(
ClientConfig(
base_url=os.environ["PARABLE_API_URL"],
auth_token=os.environ["PARABLE_API_TOKEN"],
default_headers={"X-Tenant": os.environ["PARABLE_WORKSPACE"]},
)
)
input_data = UpdateTenantConnectorTapInput.model_validate(
json.loads("{}"),
)
result = sdk.tenant_connector_taps.update_tenant_connector_tap('example', input_data)use parable_web_api_sdk::{types, ClientConfig, RequestOptions, WebApiSdk};
let sdk = WebApiSdk::new(ClientConfig::with_base_url(
std::env::var("PARABLE_API_URL")?,
Some(std::env::var("PARABLE_API_TOKEN")?),
None,
))?;
let options = RequestOptions::with_header("X-Tenant", std::env::var("PARABLE_WORKSPACE")?, None, None);
let input: types::UpdateTenantConnectorTapInput = serde_json::from_value(
serde_json::json!({}),
)?;
let result = sdk.tenant_connector_taps.update_tenant_connector_tap(
serde_json::from_value(serde_json::json!("example"))?,
input,
Some(&options)
).await?;sdk, err := webapisdk.New(webapisdk.SDKConfig{
BaseURL: os.Getenv("PARABLE_API_URL"),
Auth: &webapisdk.AuthConfig{Token: os.Getenv("PARABLE_API_TOKEN")},
RequestInterceptor: func(ctx context.Context, req *http.Request) error {
req.Header.Set("X-Tenant", os.Getenv("PARABLE_WORKSPACE"))
return nil
},
})
if err != nil {
return err
}
var input webapitypes.UpdateTenantConnectorTapInput
if err := json.Unmarshal([]byte(`{}`), &input); err != nil {
return err
}
result, err := sdk.TenantConnectorTapsNamespace.UpdateTenantConnectorTap(ctx, "example", input){
"data": {
"canonicalPersonSource": true,
"connectorTapId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"enabled": true,
"id": "<string>",
"kind": "override",
"name": "<string>",
"outputSchema": {},
"tenantConnectorId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"artifactId": "<string>",
"config": {
"catalogSlug": "<string>",
"materializedDefault": true,
"selectedFields": [
"<string>"
],
"storageUri": "<string>",
"systemDisabled": true
},
"description": "<string>",
"enabledSince": "2023-11-07T05:31:56Z"
},
"meta": {
"requestId": "<string>",
"totalCount": 123
},
"links": {
"first": "<string>",
"last": "<string>",
"next": "<string>",
"prev": "<string>"
}
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}{
"detail": "<string>",
"status": 400,
"title": "Bad Request",
"type": "about:blank",
"code": "WA-VL-001",
"details": "<unknown>",
"errors": "<unknown>",
"requestId": "<string>"
}Change a Tap's settings
change_tap_settingsAuthorizations
A personal access token, which starts with pat_. A Parable token can call each operation that the roles of its owner allow. An MCP token can call only the read operations that are open to agents. A SQL token does not work on this API.
Headers
Workspace slug. Overrides subdomain-based workspace resolution when provided.
"acme"
Optional request correlation ID echoed back in the response.
"550e8400-e29b-41d4-a716-446655440000"
Path Parameters
id parameter UUID v4 with automatic base62 encoding for client-facing APIs
Body
Patch input for updating an existing workspace connector tap. Same optional
fields as create's nested tap body so both paths validate through one
shape.
Mark this tap as one of the Workspace's canonical person/identity sources. Any number of active taps may carry the designation; ordering among canonical sources is by tap creation time, earlier wins. Null on create = false. Null on update = leave unchanged.
============================================================================= provider connection.config
Typed JSON payload for provider connection.config /. Kind-dependent keys share one object: OVERRIDE/CUSTOM may set selectedFields; ARTIFACT uses catalogSlug + storageUri; promotion sets materializedDefault. Only these keys are preserved across typed config round-trips; undeclared JSON keys are dropped when the control plane marshals this type.
- Option 1
- Option 2
Show child attributes
Show child attributes
An objects name
2 - 80A Parable Schema in JSON
Response
Successful response
Per-workspace tap configuration. Either narrows a platform ConnectorTap's
output schema for this workspace (override case) or stands in for an
artifact-derived tap (artifact case). See for the model.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?