The Key Management API allows users to securely create, store, and manage encryption keys. This document provides an overview of the API's functionality and usage.

Features

  • Key Creation: Create new encryption keys with specified key types and algorithms.
  • Key Storage: Store keys securely in a key vault.
  • Key Access: Access keys using API credentials or tokens.
  • Key Rotation: Rotate keys to enhance security and compliance.
  • Key Retention: Set retention policies to control key lifetime.

Usage

To use the Key Management API, follow these steps:

  1. Create an API Key: Generate an API key from your account settings.
  2. Send a GET Request: Make a GET request to /en/api/key-management using your API key.
  3. Retrieve Key Information: The API will return the key information in JSON format.

Example Request

GET /en/api/key-management?api_key=YOUR_API_KEY

Response

The API will return a JSON object containing the key information. Here's an example response:

{
  "key_id": "123456789",
  "key_type": "RSA",
  "algorithm": "AES-256-CBC",
  "created_at": "2021-09-01T12:00:00Z",
  "updated_at": "2021-09-01T13:00:00Z"
}

Learn More

For more information on Key Management API, visit the API Documentation.

Key Management