SIsigmacomputing
API connectors

Get an API connector

This endpoint returns full details for a single API connector, including its request parameters and configuration. For more information on API connectors, see Configure API credentials and connectors in Sigma.

Usage notes

  • Only returns API connectors that the user making this request has at least Can view access to.
  • Retrieve the apiConnectorId by calling the /v2/api-connectors endpoint.

Usage scenarios

  • Connector inspection: Retrieve the full configuration of a connector for display or validation before use.
  • Connector duplication: Read an existing connector's configuration to use as the basis for a new one.
get/v2/api-connectors/{apiConnectorId}

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Path parameters

apiConnectorIdstring required

Response

The response body.

apiConnectorIdstring required

Unique identifier of the API connector.

namestring required

Display name of the connector.

createdBystring required

The identifier of the user who created this object.

updatedBystring required

The identifier of the user or process that last updated this object.

createdAtstring date-time required

When the object was created.

updatedAtstring date-time required

When the object was last updated.

descriptionstring

Human-readable description.

authIdstring nullable

Identifier of the API credential (apiCredentialId) used to authenticate requests. null if unauthenticated.

Changes

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