Test EasyPost Connection
POST/api/easypost/instances/:integrationInstance/test-connection
Checks the saved API key live against EasyPost. A successful check clears any stored authentication error; an authentication failure is recorded on the connection's error.
integrations:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
EasyPost failures return 422 (or 502 when EasyPost is unreachable) with message, code (EasyPost's error code, e.g. APIKEY.INACTIVE, CONNECTION_FAILED) and errors.api_key.
Authentication: Requires Bearer token.
Requires permission: integrations.show
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
- 502
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.
Bad Gateway