Keys & Secrets API

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

• Export JWK File - Download the JWK Set document itself

• Import JWK File - Upload a JWK / JWK Set document directly

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
• Export Keystore - Export keystore as portable ZIP
• Import Keystore - Import keystore from export ZIP
• Export Keystore File - Download the keystore file itself (.jks / .p12 / .pfx)
• Import Keystore File - Upload a .jks / .p12 / .pfx file directly

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
• Export Key - Export key as portable ZIP
• Import Key - Import key from export ZIP
• Export Key File - Download the key material itself (PEM)
• Import Key File - Upload a key file directly

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
• Import Certificate File - Upload a certificate file into named environments
• Export Truststore File - Download everything an environment trusts, as one ZIP
• Import Truststore File - Push a bundle of CA certificates into one environment
• Get Truststore Certificates - Get certificates from environment truststore

Package or file?

Two different jobs, two different endpoints. The Export / Import endpoints produce an Apinizer package — that is how an object moves between Apinizer installations, with its description, environments and settings intact. The Export / Import File endpoints hand over the material itself — a PEM, a .jks/.p12/.pfx, a JWKS document — which is what a JVM truststore, a web server or a relying party actually consumes. Certificates have always worked this way; keys, keystores and JWKs now do too.

Authentication

All endpoints require authentication using a Personal API Access Token.

Permissions

GET Operations (List/Get Certificate/Key/Keystore/JWK)

• User must have SECRETS + VIEW permission in the project
• If the asset category does not exist, user must have at least one permission in the project

POST/PUT/DELETE Operations (Create/Update/Delete Certificate/Key/Keystore/JWK)

• User must have SECRETS + MANAGE permission in the project
• For deployment operations (when deploying certificates to environments), user must also have SECRETS + DEPLOY_UNDEPLOY permission

Permission Requirements

Operation	Required Permission
List/Get Certificate/Key/Keystore/JWK	SECRETS + VIEW (or any permission if category doesn't exist)
Create/Update/Delete Certificate/Key/Keystore/JWK	SECRETS + MANAGE
Deploy Certificate to Environment	SECRETS + DEPLOY_UNDEPLOY
Export Certificate	SECRETS + EXPORT_IMPORT
Import Certificate / Truststore file	SECRETS + EXPORT_IMPORT
Export/Import Keystore	SECRETS + EXPORT_IMPORT
Export/Import Key	SECRETS + EXPORT_IMPORT
Export/Import raw file (Key / Keystore / JWK)	SECRETS + EXPORT_IMPORT

Related Documentation

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