Send Docs Feedback

Note: Most user interface tasks can be performed in Edge Classic or the New Edge experience. For an overview, getting started topics, and release notes specific to the New Edge experience, see the docs.

Create an alias from a JAR or PKCS file

Resource Summary

Security

Content Type

multipart/form-data

Category

Keystores and Truststores,

CreateanAlias

POST

Create an alias from a JAR or PKCS file

Self-service TLS/SSL Beta: This API is available as part of the self-service TLS/SSL Beta release.

Creates a new alias in the keystore from a certificate/key pair. The input certificate/key formats supported are PKCS12 and JAR.

 

If using a JAR file to create the alias, it must include the certificate and private key files, and a META-INF/descriptor.properties file that contains the following information:

certFile=<certfile>
keyFile=<privatekeyfile>

 

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

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. Valid input values are keycertjar and pkcs12.

ignoreExpiryValidation

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

password

Password to the private key, if it exists.

Note: The password can be passed as multipart/form-data or as a query parameter. Apigee recommends that you pass the password as multipart/form-data in a production environment. Use of the query parameter is intended to be used in testing environments only.

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.

Header Parameters

Name Values Description
Content-Type
(required)

Set as multipart/form-data.

Attachments


Name Value Description
file

JAR file containing key, certificate, and a descriptor file (if "format=keycertjar"), or pfx/p12 file (if "format=pkcs12").

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?