You are viewing the Apigee Management API reference documentation. For the main product docs, and to search all docs, go to https://docs.apigee.com.

Create an alias from certificate and key PEM files

Resource Summary

Security

Content Type

multipart/form-data

Category

Keystores and Truststores,

CreateanAliasfromaCertandKeyfile

POST

Create an alias from certificate and key PEM files

Creates a new alias in the keystore from a certificate/key pair. This method requires the certificate and key to be in separate PEM files.

 

If you want to create a truststore, create aliases from certificates only. For details, see Create an alias from a certificate PEM file.

 

Deprecation Warning: The password query paramater to this method has been deprecated for security reasons. If the private key requires a password, you must pass it as multipart/form-data. For example, if you are using cURL, use the -F password option to specify the password:

 

curl -X POST -H "Content-Type: multipart/form-data" \
-F keyFile="@server.key" -F certFile="@signed.crt" \
-F password=key_pword \
"https://api.enterprise.apigee.com/v1/o/{org_name}/e/{env_name}/keystores/{keystore_name}/aliases?alias={alias_name}&format=keycertfile" \
-u orgAdminEmail:password 

 

See Creating keystores and truststores using the Edge management API for more examples.

Resource URL

https://api.enterprise.apigee.com/v1 /organizations/{org_name}/environments/{env_name}/keystores/{keystore_name}/aliases

Query Parameters

Name Values Description
alias
(required)

Alias name.

format
(required)

Type of alias creation. This value must be keycertfile.

ignoreExpiryValidation

Flag that specifies whether to validate that the certificate hasn't expired. Set this value to true to skip validation.

privateKeyExportable

Flag that specifies whether the Edge sys admin can download the private key. Set to true to enable the private key to be downloaded.

ignoreNewlineValidation

If false, do not throw an error when the certFile contains a chain with no newline between each cert. By default, Edge requires a newline between each cert in a chain.

Header Parameters

Name Values Description
Content-Type
(required)

Set to multipart/form-data.

Attachments


Name Value Description
keyFile
(required)

Private key file in PEM format.

certFile
(required)

Certificate file in PEM format.

Request Body

org_name Mention the organization name true

env_name Mention the environment name true

keystore_name Mention the keystore name true

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Working...

Help or comments?

  • If something's not working: Ask the Apigee Community or see Apigee Support.
  • If something's wrong with the docs: Click the "Send Feedback" button.
    (Incorrect? Unclear? Broken link? Typo?)