APapinizer
Key

Import a Key

Changed on

Imports a Key (CryptoKeyInfo) from a ZIP produced by the export endpoint. When override=true an existing key with the same name is overwritten; otherwise a new key is created (an '-imported' suffix is added on name conflict).

post/apiops/projects/{projectName}/keys/import/

Request

Path parameters

projectNamestring required

Query parameters

overrideboolean

When true, overrides an existing key with the same name. Defaults to false.

Headers

X-Apinizer-Package-Passphrasestring

Optional; the passphrase required to decrypt the package if it is encrypted (Base64 UTF-8). Ignored if the package is not encrypted.

Request body multipart/form-data

keyExportFilestring binary required

ZIP file produced by the key export endpoint

environmentMappingstring

Optional JSON: environment name in the package -> environment name in this installation (example: {"UAT":"Production"}). An empty value means that environment is deliberately not transferred. If omitted, the current behaviour is preserved: environments with the same name are matched, unmatched ones are dropped. Ignored when override=true.

certEnvironmentMergeMethodstring

Optional; environment matching method when override=true: MATCH_BY_NAME (default) or OVERWRITE_ALL.

certEnvironmentUncoveredActionstring

Optional; for target environments not covered by the package when override=true: FILL_FROM_PACKAGE (fill from the package) or REMOVE_FROM_TARGET (remove from the target). If omitted and an uncovered environment exists, the import is rejected with 400 (INV-36).

Response

successful operation!

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

Changes