Skip to main content

Create Connection

POST 
/api/v1/connections

Create a new data connection.

Nexatron tests the connection and reads its schema before returning, so the response already contains the final status, last_tested_at, and last_error and the connection is immediately usable for queries. Setup of definitions over the schema continues afterwards. Failures of the test or schema read are soft: the connection is always saved in one of three states:

  • test pass + discover pass → status="healthy"
  • test pass + discover fail → status="degraded" (schema introspection broke but credentials work)
  • test fail (or timeout) → status="error" (and discover skipped)

A fourth state belongs to the per-user OAuth connectors (salesforce, netsuite, quickbooks): creating one proves its configuration, never authentication. Those are status="untested" with a null last_tested_at until a person signs in.

The HTTP response is always 201: the detail of a soft failure is in the response body's status and last_error fields. A Google Sheets connection waiting on OAuth is the exception: it is validated and set up only after sign-in completes.

Summary​

POST /api/v1/connections is an operation in the connections group of the Nexatron REST API, served from https://api.nexatron.io. Send an API key as a bearer token in the Authorization header. It takes a JSON body whose required fields are name, connector_type and config. A successful call returns 201; the other documented responses are 400, 401, 403, 404, 422 and 429.

Example request​

curl -X POST "https://api.nexatron.io/api/v1/connections" \
  -H "Authorization: Bearer $NEXATRON_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"<name>","connector_type":"<connector_type>","config":{}}'

Placeholders in angle brackets stand for your own values. NEXATRON_API_KEY holds an API key from Settings → API tokens. See the API overview for authentication, errors and rate limits.

Request​

Responses​

Successful Response

Last updated on