Connectors

Update a connection

Renames a connection, updates its note, or grants team connections permission to serve sites. Credentials are immutable: to rotate one, reconnect.

patch/v1/connectors/connections/{connectionId}

Request

  • Base URL: https://api.spacefast.com
  • URL: https://api.spacefast.com/v1/connectors/connections/{connectionId}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.spacefast.com/v1/auth/oauth2/authorize, token URL https://api.spacefast.com/v1/auth/oauth2/token; client credentials, token URL https://api.spacefast.com/v1/auth/oauth2/token, scopes: connectors:write)

Path parameters

connectionIdstring required

Connection id (cxn_).

Query parameters

teamstring

Team id or slug to act for. Required only when the credential could act for more than one team.

Request body

servingboolean
displayNamestring

Replacement label.

descriptionstring nullable

Replacement agent-visible description.

Response

Response for status 200

$schemastring uri

Canonical JSON Schema URL for this response body. The server also sends it in the Link: rel="describedby" response header.

Changes

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