Keys & Secrets API

Overview

The Keys & Secrets API provides endpoints for managing cryptographic keys, keystores, JWKs (JSON Web Keys), and certificates in Apinizer. These resources are essential for secure communication, encryption, authentication, and digital signatures in API Proxies.

API Sections

JWKs (JSON Web Keys)

List JWKs - Get all JWKs for a project
Get JWK - Get a specific JWK
Create JWK - Create a new JWK
Update JWK - Update an existing JWK
Delete JWK - Delete a JWK
Generate JWK - Generate a new JWK
Parse JWK from URL - Parse and create JWK from URL
Parse JWK from Clipboard - Parse and create JWK from JSON string
Parse JWK from Certificate - Parse and create JWK from certificate
Parse JWK from Key - Parse and create JWK from key
Parse JWK from Keystore - Parse and create JWK from keystore

Keystores

List Keystores - Get all keystores for a project
Get Keystore - Get a specific keystore
Create Keystore - Create a new keystore
Update Keystore - Update an existing keystore
Delete Keystore - Delete a keystore

Keys (Crypto Keys)

List Keys - Get all keys for a project
Get Key - Get a specific key
Create Key - Create a new key
Update Key - Update an existing key
Delete Key - Delete a key

Certificates

List Certificates - Get all certificates for a project
Get Certificate - Get a specific certificate
Create Certificate - Create a new certificate
Update Certificate - Update an existing certificate
Delete Certificate - Delete a certificate
Export Certificate - Export certificate as ZIP file
Get Truststore Certificates - Get certificates from environment truststore

Authentication

All endpoints require authentication using a Personal API Access Token.

Permissions

ROLE_API_SECURITY - Required for all keys and secrets operations
ROLE_DEPLOY_UNDEPLOY_PROXIES - Required for deployment operations

Authentication Guide - How to obtain and use API tokens
Error Handling - Error response formats