Skip to content

Registry API Reference

GET /resources/registry

Gets all registry valyes that the current session has read access to.

Query Parameters
indexboolean

If true, an array of all available keys without values will be returned instead.

Request Sample
Request
GET https://<hantera-hostname>/resources/registry
Authorization: Bearer <YOUR TOKEN>
Response
Status: 200
[{
"key": "branding/name",
"value": "Alpine Adventure Wear"
}]

GET /resources/registry/<key>

Gets the value of a specific registry key or a list of all values under a specific key if the current session has read access to it.

URI Parameters
keystring

Registry keys

Query Parameters
searchTypeexact | prefix

Default value: exact

If set to prefix, the request will return any key that begins with the specified key or exactly matches.

indexboolean

If true, an array of all available keys without values will be returned instead.

Request Sample
Request
GET https://<hantera-hostname>/resources/registry/branding/name
Authorization: Bearer <YOUR TOKEN>
Response
Status: 200
{
"key": "branding/name",
"value": "Alpine Adventure Wear"
}

POST /resources/registry/<key>

Creates or updates an existing key if the current session has write access to it. Registry entries can contain any JSON value, including arrays and objects.

URI Parameters
keystring

Registry keys

Request Sample
Request
POST https://<hantera-hostname>/resources/registry/branding/name
Authorization: Bearer <YOUR TOKEN>
Content-Type: application/json
"Alpine Adventure Wear"
Response
Status: 200

DELETE /resources/registry/<key>

Deletes a Registry key if the current session has write access to it.

URI Parameters
keystring

Registry keys

Request Sample
Request
DELETE https://<hantera-hostname>/resources/registry/branding/name
Authorization: Bearer <YOUR TOKEN>
Response
Status: 200