Skip to content
Kindgi

Which runtime answers

View as Markdown
GET
/v1/runtime
curl --request GET \
  --url https://example.com/v1/runtime \
  --header 'Authorization: Bearer <token>'

Its version, how many tenants it serves and whether it runs in development mode: what a client says about the runtime it’s connected to. Any caller of a tenant reads it; no right is asked. A runtime that doesn’t report it answers 404.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

Which runtime answers.

Media typeapplication/json

Which runtime answers: what a client says about the runtime it’s connected to.

object
version
required

The runtime’s version: its release, such as 0.3.0, or what its build gave otherwise (dev when it gave none).

string
tenancy
required

single when the runtime serves one tenant, multi when it serves many.

string
Allowed values: single multi
development
required

The runtime runs in development mode, which allows development-only settings.

boolean
Example
{
  "tenancy": "single"
}

401

Section titled “401”

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

503

Section titled “503”

The database was too busy to answer in time (database-busy); Retry-After (whole seconds) says when to try again.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

See also