Bootstrap info

GET

/api/v1/bootstrap

const url = 'http://localhost:11044/api/v1/bootstrap';
const options = {method: 'GET', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:11044/api/v1/bootstrap \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Supported auth schemes, the preferred interactive login, the current user (null when anonymous), and capability flags. Values come from injected configuration, never guessed from the environment.

Authorizations

apiKeyAuth
basicAuth

Responses

200

*/*

What a fresh client needs before it can talk to the app: how to log in, and who, if anyone, is signed in. Answered by GET /bootstrap, which needs no authentication

object

capabilities

required

Feature flags a client can act on

object

apiDiscoveryEnabled

required

True when the LLM-driven “describe an API in words” discovery flow is switched on. A client should not offer that path otherwise

boolean

workosEnabled

required

True when WorkOS AuthKit login is switched on and a client registration for it exists

boolean

currentUser

The signed-in user, or null for an anonymous caller

object

displayName

The human-friendly name; null when no user record exists for the username

string

username

required

The stable login identity

string

licence

The appliance’s trial or licence, readable before sign-in so the sign-in screen can say why a locked appliance is paused. Null on a server with no licence gate

object

daysLeft

Whole days until endsAt, rounded up; null when endsAt is null

integer format: int64

endsAt

ISO-8601 instant at which the current state stops holding: the trial’s end, or the key’s expiry. Null under a key that never expires, and once expired

string

keyExpired

required

True when the appliance is expired because a licence key ran out, rather than the trial

boolean

licensee

Who the key in force was issued to (its name, else its email). Null outside licensed, or when the key names neither

string

registerUrl

required

Where to register for, or renew, a licence key

string

state

required

trial, licensed or expired. An expired appliance is locked until a valid key is entered

string

warn

required

True inside the warning window before endsAt: time to show a banner

boolean

preferredLogin

required

The scheme to lead with interactively: workos-oidc when WorkOS login is wired, otherwise session-form

string

schemaVersion

required

Version of this response’s shape, bumped when a field is removed or changes meaning; additive fields do not bump it. Currently 1

integer format: int32

supportedAuthSchemes

required

Auth schemes this deployment accepts: session-form and basic always, workos-oidc when WorkOS login is wired

Array<string>