Provisioning API · Internal testing only

getApiIndex

GET

const url = 'https://api.builders.ac/api/provisioning/v1alpha1/';
const options = {method: 'GET'};

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

curl --request GET \
  --url https://api.builders.ac/api/provisioning/v1alpha1/

Returns what this API is, which version this base path serves, and where to read the documentation and the machine-readable contract. Unauthenticated: it is the first call an integrator makes, usually before a credential exists.

Responses

200

The API index.

application/json

object

object

required

Allowed value: api

name

required

Human-readable name of this API.

string

version

required

The contract version this base path serves.

Allowed value: v1alpha1

description

required

One-line summary of the surface.

string

provider

required

Who operates the API.

string

documentation_url

required

Guides and the rendered reference for humans.

string format: uri

openapi_url

required

The machine-readable contract this document describes.

string format: uri

Example

{
  "object": "api",
  "name": "builders.ac Provisioning API",
  "version": "v1alpha1",
  "description": "Provision domains, inboxes and personas for outbound email.",
  "provider": "builders.ac",
  "documentation_url": "https://docs.builders.ac/guides/provisioning/",
  "openapi_url": "https://api.builders.ac/api/provisioning/v1alpha1/openapi.json"
}

Headers

Cache-Control

string

/^(?:public, max-age=300|max-age=300, public)$/

Public discovery metadata may be cached for five minutes.

x-correlation-id

string

The id of this request, echoed on every response and repeated in the correlation_id member of a problem body. Quote it in support requests.