Update an API connector

This endpoint updates one or more fields on an existing API connector. For more information on API connectors, see Configure API credentials and connectors in Sigma.

Usage notes

  • Retrieve the apiConnectorId by calling the /v2/api-connectors endpoint.
  • The user making this request must be assigned an account type with the Manage API connectors permission enabled and must have Can edit access to the connector.
  • Omitted fields are left unchanged. Pass null for authId to remove the credential association.

Usage scenarios

  • Endpoint migration: Update the connector URL or parameters when an external API changes its interface.
  • Credential rotation: Rebind the connector to a new credential after rotating secrets.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params

The request body.

string

New display name.

string | null

New description. Pass null to clear.

params
object
config
object
string | null

New credential binding. Pass null to remove the credential.

Responses

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json