Create an API connector

POST

/v2/api-connectors

POST

/v2/api-connectors

$ curl -X POST https://api.sigmacomputing.com/v2/api-connectors \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "string",
>   "params": {
>     "method": "GET",
>     "url": "string",
>     "headers": [
>       {
>         "key": "string",
>         "mode": "static"
>       }
>     ],
>     "pathParams": [
>       {
>         "key": "string",
>         "mode": "static"
>       }
>     ],
>     "queryParams": [
>       {
>         "key": "string",
>         "mode": "static"
>       }
>     ],
>     "body": "string"
>   }
> }'

200Successful

1 {
2   "apiConnectorId": "string",
3   "name": "string",
4   "params": {
5     "method": "GET",
6     "url": "string",
7     "headers": [
8       {
9         "key": "string",
10         "mode": "static",
11         "value": "string",
12         "type": "array",
13         "shape": {}
14       }
15     ],
16     "pathParams": [
17       {
18         "key": "string",
19         "mode": "static",
20         "value": "string",
21         "type": "array",
22         "shape": {}
23       }
24     ],
25     "queryParams": [
26       {
27         "key": "string",
28         "mode": "static",
29         "value": "string",
30         "type": "array",
31         "shape": {}
32       }
33     ],
34     "body": "string",
35     "bodyParams": [
36       {
37         "key": "string",
38         "mode": "static",
39         "value": "string",
40         "type": "array",
41         "shape": {}
42       }
43     ]
44   },
45   "config": {
46     "timeout": {
47       "requestSec": 1.1
48     },
49     "retry": {
50       "maxRetries": 1.1,
51       "retryableStatusCodes": [
52         1.1
53       ]
54     },
55     "redirects": {
56       "maxRedirects": 1.1
57     },
58     "rateLimit": {
59       "maxRequestsPerWindow": 1.1
60     }
61   },
62   "createdBy": "string",
63   "updatedBy": "string",
64   "createdAt": "2024-01-15T09:30:00Z",
65   "updatedAt": "2024-01-15T09:30:00Z",
66   "description": "string",
67   "authId": "string"
68 }

This endpoint creates a new API connector that defines how to call an external HTTP endpoint from within Sigma. For more information on API connectors, see Configure API credentials and connectors in Sigma.

Usage notes

The user making this request must be assigned an account type with the Manage API connectors permission enabled.
If a credential is provided using the authId parameter, the user making this request must have at least Can view permission on the credential and the request URL must match the credential’s allowlist.
Retrieve the apiCredentialId (used as authId) by calling the /v2/api-credentials endpoint.

Usage scenarios

Programmatic connector setup: Automate creation of API connectors as part of an environment provisioning workflow.
Integration onboarding: Create connectors for each external service your workbooks need to interact with.

This endpoint creates a new API connector that defines how to call an external HTTP endpoint from within Sigma. 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 - The user making this request must be assigned an account type with the **Manage API connectors** permission enabled. - If a credential is provided using the `authId` parameter, the user making this request must have at least **Can view** permission on the credential and the request URL must match the credential's allowlist. - Retrieve the **apiCredentialId** (used as `authId`) by calling the [/v2/api-credentials](https://help.sigmacomputing.com/reference/list-api-credentials) endpoint. ### Usage scenarios - **Programmatic connector setup:** Automate creation of API connectors as part of an environment provisioning workflow. - **Integration onboarding:** Create connectors for each external service your workbooks need to interact with.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Request

The request body.

namestringRequired

Display name of the connector.

paramsobjectRequired

descriptionstringOptional

Human-readable description.

configobjectOptional

authIdstringOptional

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

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.