Caches

List caches#

Response

Errors

Example

curl "https://api.ibel.ai/v1/cache/databases" \
  -H "Authorization: Bearer $KEY"

Create a cache#

With a read-write token default, returned once.

Request bodyapplication/json

• namestringrequired

  one DNS label: lowercase letters, digits and hyphens, 1-63 characters, no --

  pattern ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$ · up to 63 characters

• max_memory_mbinteger

  one of 32, 64, 128, 256 · default 64

• evictionboolean

  default true

Response

Errors

Example

curl -X POST "https://api.ibel.ai/v1/cache/databases" \
  -H "Authorization: Bearer $KEY" \
  -d '{"name":"sessions"}'

Get a cache#

Parameters

• namestringpathrequired

  the cache's name

  pattern ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$ · up to 63 characters

Response

Errors

Example

curl "https://api.ibel.ai/v1/cache/databases/sessions" \
  -H "Authorization: Bearer $KEY"

Delete a cache#

With its data. Refused while a live version binds it (checked after the role and the name).

Parameters

• namestringpathrequired

  the cache's name

  pattern ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$ · up to 63 characters

Response

Errors

Example

curl -X DELETE "https://api.ibel.ai/v1/cache/databases/sessions" \
  -H "Authorization: Bearer $KEY"

Change the settings of a cache#

Only the fields sent change; the cache restarts on them and keeps its data.

Parameters

• namestringpathrequired

  the cache's name

  pattern ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$ · up to 63 characters

Request bodyapplication/json

• max_storage_mbinteger
• checkpoint_daysinteger
• max_memory_mbinteger
• evictionboolean

Response

Errors

Example

curl -X PATCH "https://api.ibel.ai/v1/cache/databases/sessions" \
  -H "Authorization: Bearer $KEY" \
  -d '{"max_storage_mb":1,"checkpoint_days":1,"max_memory_mb":1,"eviction":true}'

List tokens#

Parameters

• namestringpathrequired

  the cache's name

  pattern ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$ · up to 63 characters

Response

Errors

Example

curl "https://api.ibel.ai/v1/cache/databases/sessions/tokens" \
  -H "Authorization: Bearer $KEY"

Make a token#

Parameters

• namestringpathrequired

  the cache's name

  pattern ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$ · up to 63 characters

Request bodyapplication/json

• rolestring

  one of rw, ro · default "rw"

• namestring

  up to 100 characters

Response

Errors

Example

curl -X POST "https://api.ibel.ai/v1/cache/databases/sessions/tokens" \
  -H "Authorization: Bearer $KEY" \
  -d '{"role":"rw","name":"sessions"}'

Revoke a token#

Parameters

• namestringpathrequired

  the cache's name

  pattern ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$ · up to 63 characters

• idstringpathrequired

  token id

Response

Errors

Example

curl -X DELETE "https://api.ibel.ai/v1/cache/databases/sessions/tokens/7e5926b6f29c" \
  -H "Authorization: Bearer $KEY"

Run a cache command or pipeline#

A single command the cache refuses is 400 command_error with its reply as the message.

Parameters

• namestringpathrequired

  the cache's name

  pattern ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$ · up to 63 characters

Request bodyapplication/json

CacheCommand

Response

Errors

Example

curl -X POST "https://api.ibel.ai/v1/cache/databases/sessions/command" \
  -H "Authorization: Bearer $KEY" \
  -d '["…"]'

What the plan allows for caches#

Memory and stored sizes, checkpoint days and the command rate of the plan of the team. Any role.

Response

Errors

Example

curl "https://api.ibel.ai/v1/cache/limits" \
  -H "Authorization: Bearer $KEY"

Keys, memory, hit rate and stored size of a cache#

Live from the cache; while it is idle, the stored size of the last hour with live false. Any role.

Parameters

• namestringpathrequired

  the cache's name

  pattern ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$ · up to 63 characters

Response

Errors

Example

curl "https://api.ibel.ai/v1/cache/databases/sessions/stats" \
  -H "Authorization: Bearer $KEY"

The checkpoints of a cache#

Newest first, each kept checkpoint_days. Any role.

Parameters

• namestringpathrequired

  the cache's name

  pattern ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$ · up to 63 characters

Response

Errors

Example

curl "https://api.ibel.ai/v1/cache/databases/sessions/checkpoints" \
  -H "Authorization: Bearer $KEY"

Take a cache checkpoint now#

Every write acknowledged before it is in it.

Parameters

• namestringpathrequired

  the cache's name

  pattern ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$ · up to 63 characters

Request bodyapplication/json

object

Response

Errors

Example

curl -X POST "https://api.ibel.ai/v1/cache/databases/sessions/checkpoints" \
  -H "Authorization: Bearer $KEY" \
  -d '{}'

Restore a cache from a checkpoint#

Replaces every key with the checkpoints; writes since then are lost. A session needs a step-up.

Parameters

• namestringpathrequired

  the cache's name

  pattern ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$ · up to 63 characters

• idstringpathrequired

  the checkpoint's id

  up to 128 characters

Request bodyapplication/json

object

Response

Errors

Example

curl -X POST "https://api.ibel.ai/v1/cache/databases/sessions/checkpoints/7e5926b6f29c/restore" \
  -H "Authorization: Bearer $KEY" \
  -d '{}'

Commands and bytes per minute#

Parameters

• namestringpathrequired

  the cache's name

  pattern ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$ · up to 63 characters

• hoursintegerquery

  1-744, default 1

  1–744 · default 1

Response

Errors

Example

curl "https://api.ibel.ai/v1/cache/databases/sessions/usage" \
  -H "Authorization: Bearer $KEY"

Commands, hit rate, memory, keys#

Parameters

• namestringpathrequired

  the cache's name

  pattern ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$ · up to 63 characters

• rangestringquery

  1h (1-minute steps), 24h (15 minutes) or 7d (2 hours); any other value is 400 bad_range

  one of 1h, 24h, 7d · default "1h"

Response

Errors

Example

curl "https://api.ibel.ai/v1/cache/databases/sessions/observability" \
  -H "Authorization: Bearer $KEY"