APapinizer
Key

Export an existing Key

Changed on

Exports an existing Key (CryptoKeyInfo) as a portable ExportFile JSON inside a ZIP. @SecretData fields (key content + password) are decrypted into the export so it is portable across instances; the import flow re-encrypts them.

get/apiops/projects/{projectName}/keys/{keyName}/export/

Request

Path parameters

projectNamestring required
keyNamestring required

Name of key

Query parameters

encryptboolean

Optional; if true, the package is encrypted with the passphrase supplied in the X-Apinizer-Package-Passphrase header (the passphrase is then REQUIRED). If false or omitted, the package is produced unencrypted.

Headers

X-Apinizer-Package-Passphrasestring

Optional; the passphrase required to encrypt the package when encrypt=true (Base64 UTF-8). Ignored when encrypt=false.

Response

successful operation!

status'SUCCESS' | 'FAILURE'
resultMessagestring
resultListstring[]
resultCountinteger
unresolvedReferencesstring[]

Changes

  • d1a546deccf0Revision changes
    • breaking

      added the new path request parameter keyName

    • breaking

      for the query request parameter encrypt, default value false was added

    • breaking

      for the query request parameter encrypt, the type changed from string to boolean

    This list may be incomplete.

  • 9ae232e55479Revision changes
    • info

      endpoint added