Rename a connection, or rotate its credentials
connection:writeA full-object PUT with one deliberate exception: config is OPTIONAL, and its ABSENCE is meaningful.
- Omit
config→ RENAME-ONLY. The stored encrypted credential is left completely untouched. This is how you rename a live connection whose secret you cannot read back. - Send
config→ the credential is REPLACED WHOLESALE and re-encrypted. It is not merged key by key: any field you leave out is gone, and"config": {}wipes the credential. Because the current value is unreadable, only send this when you hold the complete new credential.
name is REQUIRED on every call, including a credential-only rotation; empty or missing is a 400. authType is optional and an empty string leaves the stored value unchanged.
pieceId CANNOT be changed — it is not read from the body at all. To point at a different piece, create a new connection.
This does not re-test the credentials and does not change status or lastTestedAt; call POST /api/connections/{id}/test afterwards if you want the verdict refreshed.
Authorization
bearerAuth An API token: Authorization: Bearer grt_…. Mint one in the app under Settings → Workspace → API tokens; the raw value is shown once. Scopes confine the token — see x-permission on each operation.
In: header
Path Parameters
The connection's UUID.
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/api/connections/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{ "name": "Slack — ops bot" }'{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "pieceId": "string", "name": "string", "authType": "string", "status": "active", "lastTestedAt": "2019-08-24T14:15:22Z", "tokenExpiresAt": "2019-08-24T14:15:22Z", "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c", "orgId": "25b2c2d5-a7fc-47d0-89e4-8709a1560bfa", "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }}