Read the effective principles

GET

/api/v1/admin/principles

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

The operator’s file when one exists, else the shipped default. overridden says which.

Authorizations

apiKeyAuth
basicAuth

Responses

200

The principles and their provenance

*/*

The appliance’s effective architectural principles, as coding agents receive them, and where they came from; answered by GET /admin/principles

object

content

required

The principles text, plain text or markdown, exactly as coding agents receive it; empty only if the shipped default is missing

string

overridden

required

True when the operator’s own file is in force; false when the shipped default is

boolean