{
  "opencollection": "1.0.0",
  "info": {
    "name": "openobserve Actions Key API",
    "version": "0.90.0"
  },
  "items": [
    {
      "info": {
        "name": "Key",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List encryption keys",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/:org_id/cipher_keys",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Create encryption key",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "{{baseUrl}}/api/:org_id/cipher_keys",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Get encryption key details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "{{baseUrl}}/api/:org_id/cipher_keys/:key_name",
            "params": [
              {
                "name": "key_name",
                "value": "test_key",
                "type": "path",
                "description": "Name of the key to retrieve"
              },
              {
                "name": "org_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "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."
        },
        {
          "info": {
            "name": "Update encryption key",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "{{baseUrl}}/api/:org_id/cipher_keys/:key_name",
            "params": [
              {
                "name": "org_id",
                "value": "",
                "type": "path",
                "description": "Organization name"
              },
              {
                "name": "key_name",
                "value": "test_key",
                "type": "path",
                "description": "name of the key to update"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "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."
        }
      ]
    }
  ],
  "bundled": true
}