{ "opencollection": "1.0.0", "info": { "name": "openobserve Actions KV API", "version": "0.90.0" }, "items": [ { "info": { "name": "KV", "type": "folder" }, "items": [ { "info": { "name": "List keys from key-value store", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/:org_id/kv", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "Organization name" }, { "name": "prefix", "value": "", "type": "query", "description": "Key prefix" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves a list of all keys stored in the organization's key-value store. You can optionally filter keys by providing a prefix to only return keys that start with specific characters. This is useful for organizing related configuration settings or browsing available stored data." }, { "info": { "name": "Get value from key-value store", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/api/:org_id/kv/:key", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "Organization name" }, { "name": "key", "value": "", "type": "path", "description": "Key name" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Retrieves the stored value for a specific key from the organization's key-value store. Returns the raw text value if the key exists, or a 404 error if the key is not found. Useful for storing and retrieving configuration settings, application state, or other simple data." }, { "info": { "name": "Store value in key-value store", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/api/:org_id/kv/:key", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "Organization name" }, { "name": "key", "value": "", "type": "path", "description": "Key name" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Stores a text value under the specified key in the organization's key-value store. Creates a new key if it doesn't exist, or updates the existing value. The key-value store is perfect for configuration settings, feature flags, application state, and other simple data that needs to persist across sessions." }, { "info": { "name": "Delete key from key-value store", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/api/:org_id/kv/:key", "params": [ { "name": "org_id", "value": "", "type": "path", "description": "Organization name" }, { "name": "key", "value": "", "type": "path", "description": "Key name" } ], "auth": { "type": "apikey", "key": "Authorization", "value": "{{Authorization}}", "placement": "header" } }, "docs": "Permanently removes a key and its associated value from the organization's key-value store. Returns a success response if the key was deleted, or a 404 error if the key doesn't exist. This operation cannot be undone, so use carefully when cleaning up unused configuration or application data." } ] } ], "bundled": true }