Skip to content
Kindgi

Read a tenant

View as Markdown
GET
/v1/system/tenants/{tenantId}
curl --request GET \
  --url https://example.com/v1/system/tenants/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Its state, switch, image prefix and dates. Takes system:tenants.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
tenantId
required
string format: uuid

The tenant’s id.

Responses

Section titled “Responses”

200

Section titled “200”

The tenant.

Media typeapplication/json

A tenant, as the operator sees it: never its content.

object
id
required
string format: uuid
name
required
string
slug
required
string
state
required

closing: readable and exportable with its own keys for its window, nothing runs. suspended: the same, reversibly. closing wins over suspended.

string
Allowed values: active suspended closing
createdAt
required
string format: date-time
test
required

A test tenant: left out of usage, invoices and counts.

boolean
productionAllowed
required
boolean
imagePrefix

The repository its deployments’ images must sit at or under, <host>/<path>.

string
closingAt
string format: date-time
suspendedAt
string format: date-time
suspendedReason
string
Example
{
  "state": "active"
}

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"
  }
}

403

Section titled “403”

A tenant’s key or session (system-principal-required), or a system key without system:tenants (system-scope-missing).

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"
  }
}

404

Section titled “404”

No tenant with that id, or a purged one (tenant-not-found).

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