StudioHomepage
ServicesConnectionsHTTP APIUnknown

Update_description

PATCH
/api/connections/{connection_id}

Replace the description. Omit it to clear the description.

Authorization

bearerAuth
headerAuthorizationBearer <token>

Path Parameters

connection_id*string
Formatuuid

Request Body

application/json
  1. body
description?string|null

Response Body

Success

application/json
  1. response
connection*
curl -X PATCH 'https://api.spiraldb.dev/api/connections/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{}'
{  "connection": {    "allowedAccess": "read",    "connectionId": "84b500d7-71c8-4b1f-adf4-f1eb0000973d",    "createdAtMicros": "string",    "createdBy": "string",    "credential": {      "awsAccessKey": {        "accessKeyId": "string",        "region": "string"      },      "type": "awsAccessKey"    },    "credentialUpdatedAtMicros": "string",    "description": "string",    "dropped": {      "droppedAtMicros": "string",      "droppedBy": "string"    },    "identity": {      "audience": "string",      "issuer": "string",      "subject": "string",      "trustPolicy": "string"    },    "projectId": "string",    "uri": "string"  }}