Component versions, Bolt endpoints and the SQL door

GET

/api/v1/about

const url = 'http://localhost:11044/api/v1/about';
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/about \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

The server’s commit, its libraries’ versions, the release it follows, and the listening Bolt ports and SQL door.

Authorizations

apiKeyAuth
basicAuth

Responses

200

Components, server first, the release, and Bolt and SQL when they are on

*/*

What this server is built from, and where else it can be reached.

object

bolt

The Bolt server, when it is on and listening; absent otherwise

object

endpoints

required

Each port that is listening, Virtual Cypher first

Array<object>

One Bolt port, as a Bolt driver or graph browser dials it.

object

address

required

The address the server advertises for this port, host:port

string

Example

localhost:11050

answers

required

What that database answers, in a sentence

string

database

required

The database a session on this port gets when it names none

string

Example

world

mode

required

What a session on this port runs against when it names no database

string

Allowed values: virtual persisted

tls

required

Whether the port speaks TLS, so the URL is bolt+s:// rather than bolt://

boolean

url

required

The URL to connect to

string

Example

bolt://localhost:11050

components

required

The server first, then the libraries it is built on

Array<object>

One part of the running server and the build of it that is running.

object

commit

Full git commit SHA, when the component was built with one

string

name

required

Human name of the component

string

Example

Embabel Agent

version

Released or snapshot version, when the component carries one

string

release

Stable, beta, nightly, canary, or the exact version or sha- pinned; null when unset

string

Example

beta

sql

The SQL door, when it is on and listening; absent otherwise

object

address

required

The address the server advertises for the door, host:port

string

Example

localhost:11052

answers

required

What that database answers, in a sentence

string

database

required

The database the door answers as, whatever name a client connects to

string

Example

world

url

required

The URL to connect to; the client supplies the user and password

string

Example

postgresql://localhost:11052/world