Skip to main content

Using Sentinels

Explanation of the Sentinel Object​

  • id: Unique identifier of the sentinel.
  • key_size: Size of the encryption key, which can be "AES-128" or "AES-256" depending on the license level.
  • cipher: The encryption key itself.
  • sum: The SHA-512 checksum of the encryption key, used to verify the integrity of the key.
{
  "id": "string",
  "key_size": "string",
  "cipher": "string",
  "sum": "string"
}

Creating a Sentinel​

To create a sentinel, a user with the ROLE_USER role must send a POST request with the list of clusters.

note

If the list of clusters is empty, the sentinel will only be accessible by the creator.

curl -X POST https://<BASE_URL>:<PORT>/sentinels \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <access_token>" \
-H "X-NONCE: <RANDOM_NONCE>" \
-H "X-FINGERPRINT: <UNIQUE_DEVICE_ID> \
-d '{
  "clusters": ["<CLUSTER_ID_2>", "<CLUSTER_ID_2>", ...]
}'

Retrieving a Sentinel​

To retrieve the details of a specific sentinel, a user with the ROLE_USER role must send a GET request with the sentinels id.

curl -X POST https://<BASE_URL>:<PORT>/sentinels/<ID> \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <access_token>" \
-H "X-NONCE: <RANDOM_NONCE>" \
-H "X-FINGERPRINT: <UNIQUE_DEVICE_ID> \

Deleting a Sentinel​

To delete a sentinel, a user with the ROLE_USER role must send a DELETE request with the sentinel's id.

Copy code
curl -X DELETE https://<BASE_URL>:<PORT>/sentinels/<sentinel_id> \
-H "Content-Type: application/json" \
-H "Authorization: Bearer <access_token>"
-H "X-NONCE: <RANDOM_NONCE>" \
-H "X-FINGERPRINT: <UNIQUE_DEVICE_ID> \