TRtryardent
v1-connectors

Update Connector Endpoint

Changed on

Update connector. If connection_details changed, re-tests connection and resets indexing_status.

put/v1/connectors/{connector_id}

Request

  • Base URL
    https://api.tryardent.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.tryardent.com/v1/connectors/{connector_id}
  • Auth
    none declared

Path parameters

connector_idstring required

Request body

namestring nullable

New connector name.

project_idstring nullable

Move the connector to this project.

connection_detailsobject nullable

Replacement connection details for the source database.

drop_extensionsstring[] nullable

Extensions to drop on branches; omit to leave unchanged, [] clears.

Response

The updated connector row.

idstring required

Connector ID.

org_idstring required

Organization the connector belongs to.

project_idstring nullable

Project the connector belongs to.

namestring required

Connector name.

service_namestring required

Service type. postgresql today.

statusstring nullable

Current connector status.

created_atstring nullable

When the connector was created.

can_updateboolean nullable

Whether the caller may update this connector.

can_deleteboolean nullable

Whether the caller may delete this connector.

Changes