Provisioning API · Internal testing only

listProvisioningProblems

GET

/problems

const url = 'https://api.builders.ac/api/provisioning/v1alpha1/problems';
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/problems

Every problem type this API can answer with. Unauthenticated, and the answer changes only when the deployment does.

Responses

200

The problem catalogue.

application/json

object

object

required

Allowed value: list

data

required

Array<object>

object

type

required

The stable identifier a Problem body carries in type.

string format: uri

code

required

string

/^[a-z0-9_]+$/

title

required

string

status

required

integer

>= 400 <= 599

detail

required

string

retryable

required

Whether repeating the request unchanged can succeed later.

boolean

Example

{
  "object": "list",
  "data": [
    {
      "type": "https://api.builders.ac/api/provisioning/v1alpha1/problems/authentication_required",
      "code": "authentication_required",
      "title": "Authentication required",
      "status": 401,
      "detail": "Provide an active Provisioning API Key as a Bearer token.",
      "retryable": false
    }
  ]
}

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.