Provisioning API · Internal testing only

getProvisioningProblem

GET

/problems/{code}

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

Resolves one problem type. This is the URL a Problem body carries in type.

Parameters

Path Parameters

code

required

string

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

Responses

200

Problem type documentation

application/json

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

{
  "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.

404

Not found. The example shows not_found.

application/problem+json

object

type

required

string format: uri-reference

title

required

string

status

required

integer

detail

required

string

code

required

Extensible enum. Branch on this, never on title. New codes may appear at any time, so treat an unrecognised one as its HTTP status; GET /problems lists every code this version can answer with, and GET /problems/{code} resolves one.

string

retryable

required

boolean

retry_after

string format: date-time

correlation_id

required

string

errors

object

key

additional properties

Array<string>

Example

{
  "type": "https://api.builders.ac/api/provisioning/v1alpha1/problems/not_found",
  "title": "Not found",
  "status": 404,
  "detail": "The requested resource was not found.",
  "code": "not_found",
  "retryable": false,
  "correlation_id": "9f1c2b7a-3d5e-4c81-9a77-2f6b0e4d51c3"
}

Headers

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.