Connectors

Update a connector

Updates an existing connector by UUID.

post/connectors/{uuid}

Request

  • Base URL: https://api.artie.com
  • URL: https://api.artie.com/connectors/{uuid}
  • Auth: HTTP bearer

Path parameters

uuidstring required

Request body

dataPlaneNamestring
defaultDatabasestring nullable
environmentUUIDstring uuid nullable
labelstring
sharedConfigobject nullable
sshTunnelUUIDstring uuid nullable
typestring
uuidstring

Response

OK

companyUUIDstring uuid required
connectionLabelstring
createdAtstring date-time required
dataPlaneNamestring nullable
defaultDatabasestring
environmentUUIDstring uuid required
isValidboolean required
labelstring required
sharedConfigunknown
sshTunnelUUIDstring uuid nullable
type'api' | 'bigquery' | 'clickhouse' | 'cockroach' | 'databricks' | 'documentdb' | 'dynamodb' | 'gcs' | 'iceberg' | 'keyspaces' | 'mongodb' | 'motherduck' | 'mssql' | 'mysql' | 'oracle' | 'postgresql' | 'redis' | 'redshift' | 's3' | 'snowflake' required
updatedAtstring date-time required
uuidstring uuid required

Changes

No recorded changes to this operation across all 1 revision of this API.