connections

Update connection

Rename a connection or update its credentials. Connectors that use it pick up new credentials.

Required permission: connections.update.

patch/v1/projects/{project_id}/connections/{connection_id}

Request

  • Base URL: https://api.connic.co
  • URL: https://api.connic.co/v1/projects/{project_id}/connections/{connection_id}
  • Auth: HTTP bearer

Path parameters

project_idstring uuid required

ID of the project the API key belongs to.

connection_idstring uuid required

Connection ID from GET /connections.

Request body

namestring nullable

New name, unique per connection type in the project.

configobject nullable

Complete set of credential fields. Secret fields sent as ******** or left empty keep their stored value unless a field they belong with, such as the host or username, changes.

Response

Successful Response

idstring uuid required
project_idstring uuid required

Project the connection belongs to.

namestring required
typestring required

Connection type. Related connector types that share credentials use the same type.

configobject required

Credential fields, with secret fields masked as ********.

created_atstring required
updated_atstring required
connector_idsstring[]

IDs of the connectors that use this connection, in any environment.

Changes

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