Update all realms

POST

/api/v1/realms/update-all

const url = 'http://localhost:11044/api/v1/realms/update-all';
const options = {method: 'POST', 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 POST \
  --url http://localhost:11044/api/v1/realms/update-all \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Updates Git-backed realm references; local-directory references are already live.

Authorizations

apiKeyAuth
basicAuth

Responses

200

Update results for each realm

*/*

The outcome of updating every realm, one row each. One realm failing does not stop the rest

object

results

required

One row per loaded realm

Array<object>

What updating one realm did. A failed row carries message in place of summary

object

message

Why the pull failed. Present only on a failure

string

name

required

The realm’s name

string

status

required

updated after a pull, local for a realm loaded in place, error when the pull failed

string

Allowed values: updated local error

summary

What the pull did, or that a local realm is loaded in place. Absent on a failure

string