Skip to main content

Test Connection

POST 

/api/integrations/17track/test

Validate a 17TRACK API key WITHOUT persisting an instance — powers the connect-modal Test Connection button.

Authorization

Any valid API token can call this endpoint — no specific scope required. Manage tokens.

Under the hood the supplied key is sent to 17TRACK's /getquota endpoint; the response reports the quota so the UI can warn before connecting.

Required Fields:

  • api_key — 17TRACK API key (string, 8–255 chars)

Responses:

  • 200 OK — key is valid, returns the live quota
  • 422 Unprocessable Entity with code: invalid_key — 17TRACK rejected the key (auth error)
  • 422 Unprocessable Entity with code: api_error — 17TRACK API returned a non-auth error (rate-limited, upstream failure, etc.)

Request

Responses

OK

Response Headers
    Content-Type