APapinizer
ApiProxy

Import an API Proxy by overriding existing one

Imports an API Proxy, by overriding existing one if there is, if there is not creates a new API Proxy with provided configuration.

put/apiops/projects/{projectName}/apiProxies/{apiProxyName}/import/

Request

Path parameters

projectNamestring required
apiProxyNamestring required

Query parameters

withDependenciesboolean

Optional; if true, the dependencies carried in the package are resolved against the target project: if an object with the SAME NAME exists in the target project it is bound to that object, otherwise it is imported as new. If false or omitted, the package is imported as-is (default, current behaviour). If the package carries no dependencies, this parameter has no effect.

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

metadatastring required

metadata value has the metadata needed to create API Proxy and it is optional

apiProxyExportFilestring binary required
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.

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

No recorded changes to this operation across all 21 revisions of this API.