v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13134345498.3 KB
organizations

Creates an alias from a key/certificate pair. The structure of the request is controlled by the format query parameter: - keycertfile - Separate PEM-encoded key and certificate files are uploaded. Set Content-Type: multipart/form-data and include the keyFile, certFile, and password (if keys are encrypted) fields in the request body. If uploading to a truststore, omit keyFile. - pkcs12 - A PKCS12 file is uploaded. Set Content-Type: multipart/form-data, provide the file in the file field, and include the password field if the file is encrypted in the request body. - selfsignedcert - A new private key and certificate are generated. Set Content-Type: application/json and include CertificateGenerationSpec in the request body.

post/v1/{+parent}/aliases

Path parameters

parentstring required

Required. Name of the keystore. Use the following format in your request: organizations/{org}/environments/{env}/keystores/{keystore}.

Query parameters

_passwordstring

DEPRECATED: For improved security, specify the password in the request body instead of using the query parameter. To specify the password in the request body, set Content-type: multipart/form-data part with name password. Password for the private key file, if required.

aliasstring

Alias for the key/certificate pair. Values must match the regular expression [\w\s-.]{1,255}. This must be provided for all formats except selfsignedcert; self-signed certs may specify the alias in either this parameter or the JSON body.

formatstring

Required. Format of the data. Valid values include: selfsignedcert, keycertfile, or pkcs12

ignoreExpiryValidationboolean

Flag that specifies whether to ignore expiry validation. If set to true, no expiry validation will be performed.

ignoreNewlineValidationboolean

Flag that specifies whether to ignore newline validation. If set to true, no error is thrown when the file contains a certificate chain with no newline between each certificate. Defaults to false.

Request body

datastring byte

The HTTP request/response body as raw binary.

contentTypestring

The HTTP Content-Type header value specifying the content type of the body.

extensionsobject[]

Application specific response metadata. Must be set in the first response for streaming APIs.

Response

Successful response