Sign in
connections > connections

Update Connection

Update a connection's name or description

patch/api/v0/connections/{connection_name_or_id}

Path parameters

string uuid required
OR
string required

The connection name or UUID

Headers

Authorizationstring required

Bearer authentication

Request body

namestring required

The new connection name

descriptionstring nullable

The new connection description

Response

Successful Response

connection_idstring uuid required

The unique identifier for the connection

namestring required

The connection name

descriptionstring nullable

The connection description

type'https_basic' | 'https_bearer' | 'aws_iam_role' required

The type of connection

status'pending' | 'ready' | 'error' required

The status of a connection

created_dtstring date-time required

When the connection was created

updated_dtstring date-time required

When the connection was last updated

Changes