API docs by Redocly

Sintj API (1.5.0)

Download OpenAPI specification:

Sintj Rails 8.1 API — spec-first, contract-validated.

Health

Service health and liveness

Health check

Returns 200 when the service is running. No authentication required.

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}

Zones

Data residency zone catalogue (internal admin API)

List data residency zones

Returns all active zones available for tenant provisioning. Requires an internal service key — not exposed to end users. Returns 409 if no zones are configured (a deployment configuration error).

Authorizations:
ServiceKey

Responses

Response samples

Content type
application/json
{
  • "zones": [
    ]
}

Add a data residency zone

Creates a new active zone available for tenant provisioning. Requires an internal service key — not exposed to end users.

Authorizations:
ServiceKey
Request Body schema: application/json
required
required
object (ZoneInput)

Responses

Request samples

Content type
application/json
{
  • "zone": {
    }
}

Response samples

Content type
application/json
{
  • "zone": {
    }
}

Tenants

Tenant provisioning (internal admin API)

Get tenant detail

Returns a tenant's full record including per-step onboarding status. Requires an internal service key — not exposed to end users.

Authorizations:
ServiceKey
path Parameters
id
required
string <uuid>
Example: 7c9e6679-7425-40de-944b-e07fc1f90ae7

Responses

Response samples

Content type
application/json
{
  • "tenant": {
    }
}

Provision a new tenant

Creates a tenant record and seeds pending onboarding status rows. Requires an internal service key — not exposed to end users.

Authorizations:
ServiceKey
Request Body schema: application/json
required
required
object (TenantInput)

Responses

Request samples

Content type
application/json
{
  • "tenant": {
    }
}

Response samples

Content type
application/json
{
  • "tenant": {
    }
}