EdgeKV API-Items

Number of APIs: 4

1. List items within a group

GET https://{{host}}/edgekv/v1/networks/:network/namespaces/:namespaceId/groups/:groupId

View the details of an EdgeKV item (key-value pair) within a group. You need to specify the namespace and group the item belongs to. This operation returns up to 100 items by default or the number of items specified in the maxItems. If there are more than the default or requested items in the specified group, the operation returns a random set of the default or requested items. It can take ten seconds or longer to read an item that has been written to EdgeKV. The API may respond with a 404 error during that period. This is normal behavior for EdgeKV, which is an eventually consistent database.

---

2. Read an item

GET https://{{host}}/edgekv/v1/networks/:network/namespaces/:namespaceId/groups/:groupId/items/:itemId

Read an EdgeKV item. You need to specify the namespace and group the item belongs to. It can take ten seconds or longer to read an item that has been recently written to EdgeKV. The API may return a 404 error during that period. This is normal behavior for EdgeKV, which is an eventually consistent database.

---

3. Write an item

PUT https://{{host}}/edgekv/v1/networks/:network/namespaces/:namespaceId/groups/:groupId/items/:itemId

Create or update an EdgeKV item (name-value). You need to specify the namespace and group the item belongs to. The target namespace must already exist before writing, while the group is automatically created for you if it doesn't exist yet.

---

4. Delete an item

DELETE https://{{host}}/edgekv/v1/networks/:network/namespaces/:namespaceId/groups/:groupId/items/:itemId

Mark an EdgeKV item for deletion. You need to specify the namespace and group the item belongs to. It can take ten seconds or longer for a deleted item to be removed from the database. If you attempt a read operation before the value has been updated globally, stale data may be returned until the update is complete. This is normal behavior for EdgeKV, which is an eventually consistent database.

---