Sign Up

System

GET
/config

Returns public settings clients need before signing in.

Response Body

The runtime configuration

application/json
  1. response

The /config response body.

analytics*|

Browser analytics configuration. null when analytics is disabled.

analytics_url?|

Public base URL for spending analytics. null when unavailable.

api_url?|

Public base URL of this API when the deployment advertises one.

billing_enabled*boolean

Whether billing features are available.

build_sha*string

Full commit SHA this API was built from; unknown when unstamped.

built_at?|

Build time. null for an unstamped build.

Formatdate-time
docs_url?|

Public documentation site URL for this deployment.

oidc*|

Login settings. null when login is unavailable.

ssh_gateway*|

SSH gateway endpoint clients should use. null when the deployment does not publish one.

toolbox_url?|

Base URL for sandbox tools that the browser should use.

version*string

Platform version, or 0.0.0-dev for an unstamped build.

curl -X GET 'https://example.com/config'
{  "analytics": null,  "analytics_url": "string",  "api_url": "string",  "billing_enabled": true,  "build_sha": "string",  "built_at": "2019-08-24T14:15:22Z",  "docs_url": "string",  "oidc": null,  "ssh_gateway": null,  "toolbox_url": "string",  "version": "string"}

Get API health

GET
/health

Reports whether this API instance is serving requests. It covers the instance itself, not the availability of every individual operation.

Response Body

The API health

application/json
  1. response

API health and build identity.

build_sha*string

Full commit SHA this binary was built from; unknown when unstamped.

built_at?|

Build time. null for an unstamped build.

Formatdate-time
status*string

Health status.

version*string

Platform version this binary was built as (the latest published release); 0.0.0-dev for an unstamped build.

curl -X GET 'https://example.com/health'
{  "build_sha": "string",  "built_at": "2019-08-24T14:15:22Z",  "status": "string",  "version": "string"}