Get an API connector

GET

/v2/api-connectors/:apiConnectorId

GET

/v2/api-connectors/:apiConnectorId

$ curl https://api.sigmacomputing.com/v2/api-connectors/apiConnectorId \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "apiConnectorId": "api-123e4567-e89b-12d3-a456-426614174000",
3   "name": "GitHub Repository Info",
4   "params": {
5     "method": "GET",
6     "url": "https://api.github.com/repos/sigmacomputing/sigma-api",
7     "headers": [
8       {
9         "key": "Accept",
10         "mode": "static",
11         "value": "application/vnd.github.v3+json",
12         "type": "string",
13         "shape": null
14       },
15       {
16         "key": "Authorization",
17         "mode": "dynamic",
18         "value": null,
19         "type": "string",
20         "shape": null
21       }
22     ],
23     "pathParams": [],
24     "queryParams": [
25       {
26         "key": "ref",
27         "mode": "static",
28         "value": "main",
29         "type": "string",
30         "shape": null
31       }
32     ],
33     "body": "",
34     "bodyParams": []
35   },
36   "config": {
37     "timeout": {
38       "requestSec": 30
39     },
40     "retry": {
41       "maxRetries": 3,
42       "retryableStatusCodes": [
43         429,
44         500,
45         502,
46         503,
47         504
48       ]
49     },
50     "redirects": {
51       "maxRedirects": 5
52     },
53     "rateLimit": {
54       "maxRequestsPerWindow": 1000
55     }
56   },
57   "createdBy": "user-789e1234-e56b-78d9-a012-345678901234",
58   "updatedBy": "user-789e1234-e56b-78d9-a012-345678901234",
59   "createdAt": "2024-01-15T09:30:00Z",
60   "updatedAt": "2024-04-10T14:45:00Z",
61   "description": "Connector to fetch repository details from GitHub API.",
62   "authId": "cred-456e7890-f12b-34d5-a678-901234567890"
63 }

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.

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](https://help.sigmacomputing.com/docs/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](https://help.sigmacomputing.com/reference/list-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.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

apiConnectorIdstringRequired

Response

The response body.

apiConnectorIdstring

Unique identifier of the API connector.

namestring

Display name of the connector.

paramsobject

configobject

createdBystring

The identifier of the user who created this object.

updatedBystring

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

createdAtdatetime

When the object was created.

updatedAtdatetime

When the object was last updated.

descriptionstring

Human-readable description.

authIdstring or null

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