Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
openapi: 3.2.0
info:
title: openobserve Actions Key API
description: OpenObserve API documents [https://openobserve.ai/docs/](https://openobserve.ai/docs/)
contact:
name: OpenObserve
url: https://openobserve.ai/
email: hello@zinclabs.io
license:
name: AGPL-3.0
identifier: AGPL-3.0
version: 0.90.0
servers:
- url: https://api.openobserve.ai
description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Key
paths:
/api/{org_id}/cipher_keys:
get:
tags:
- Key
summary: List encryption keys
description: Retrieves a list of all encryption keys available within the organization. Returns key names and metadata without exposing sensitive key material. Helps administrators manage encryption keys, audit key usage, and ensure proper key lifecycle management. Only available in enterprise deployments for enhanced security and compliance.
operationId: ListCipherKeys
parameters:
- name: org_id
in: path
required: true
schema:
type: string
responses:
'200':
description: list all keys in the org
content:
application/json:
schema:
type: object
x-o2-mcp:
enabled: false
post:
tags:
- Key
summary: Create encryption key
description: Creates a new encryption key for data encryption and decryption operations. The key is securely stored and validated before being made available for use. Key names cannot contain ':' characters. Only available in enterprise deployments for enhanced data security and compliance requirements.
operationId: CreateCipherKey
parameters:
- name: org_id
in: path
required: true
schema:
type: string
requestBody:
description: Key data to add
content:
application/json:
schema:
type: object
required:
- name
- key
properties:
key:
type: object
name:
type: string
required: true
responses:
'200':
description: Empty response
content:
application/json:
schema:
default: null
'400':
description: Invalid request
content:
application/json: {}
x-o2-mcp:
enabled: false
/api/{org_id}/cipher_keys/{key_name}:
get:
tags:
- Key
summary: Get encryption key details
description: Retrieves the configuration and metadata for a specific encryption key by name. Returns key information without exposing sensitive key material. Used for managing and auditing encryption keys within the organization. Only available in enterprise deployments for enhanced security management.
operationId: GetCipherKey
parameters:
- name: key_name
in: path
description: Name of the key to retrieve
required: true
schema:
type: string
example: test_key
- name: org_id
in: path
required: true
schema:
type: string
responses:
'200':
description: Key info
content:
application/json:
schema:
type: object
'404':
description: Key not found
content:
text/plain: {}
x-o2-mcp:
enabled: false
put:
tags:
- Key
summary: Update encryption key
description: Updates the configuration and parameters of an existing encryption key. The key is validated after updates to ensure it remains functional for encryption and decryption operations. Changes are applied atomically to maintain data security and consistency. Only available in enterprise deployments for enhanced security management.
operationId: UpdateCipherKey
parameters:
- name: org_id
in: path
description: Organization name
required: true
schema:
type: string
- name: key_name
in: path
description: name of the key to update
required: true
schema:
type: string
example: test_key
requestBody:
description: updated key data
content:
application/json:
schema:
type: object
required:
- name
- key
properties:
key:
type: object
name:
type: string
required: true
responses:
'200':
description: Empty response
content:
application/json:
schema:
default: null
'400':
description: Invalid request
content:
application/json: {}
x-o2-mcp:
enabled: false
components:
securitySchemes:
Authorization:
type: apiKey
in: header
name: Authorization
BasicAuth:
type: http
scheme: basic