A realm's icon

GET

/api/v1/realms/{name}/icon

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

The image the realm declares as icon in realm.yml. 404 when the realm has none, names one that is missing, or names one outside its own directory.

Authorizations

apiKeyAuth
basicAuth

Parameters

Path Parameters

name

required

string

Name of an installed realm, as its realm.yml gives it and GET /api/v1/realms lists it; 404 when no loaded realm has that name

Responses

200

The icon

*/*

string format: byte

404

No icon