Digital Certificates - Request a Certificate

Request a certificate

Request a new certificate for your account.

post/workspace/tls/certificates/request

Request body

idinteger
namestring required
certificatestring nullable
private_keystring nullable
issuerstring nullable
subject_namestring[]
validitystring nullable
type'certificate' | 'trusted_ca_certificate'

The value can't be changed after the certificate creation.

  • certificate - Certificate
  • trusted_ca_certificate - Trusted CA Certificate
managedboolean
status'pending' | 'challenge_verification' | 'active' | 'inactive' | 'expired' | 'failed'
  • pending - Pending
  • challenge_verification - Challenge Verification
  • active - Active
  • inactive - Inactive
  • expired - Expired
  • failed - Failed
status_detailstring
csrstring nullable
challenge'dns' | 'http' required
  • dns - Uses DNS to solve the ACME challenge.
  • http - Uses HTTP to solve the ACME challenge.
authority'lets_encrypt' required
  • lets_encrypt - lets_encrypt
key_algorithm'rsa_2048' | 'rsa_4096' | 'ecc_384'
  • rsa_2048 - 2048-bit RSA
  • rsa_4096 - 4096-bit RSA
  • ecc_384 - 384-bit Prime Field Curve
activeboolean
product_versionstring
last_editorstring
created_atstring date-time nullable

Timestamp of the certificate creation on the platform.

last_modifiedstring date-time

Timestamp of the last modification made to the certificate content on the platform.

renewed_atstring date-time nullable

Timestamp indicating when the managed certificate was renewed on our platform.

common_namestring required
alternative_namesstring[]
source_certificateinteger nullable

Response

Certificate request submitted successfully.

statestring

Changes

No recorded changes to this endpoint across all 1 revision of this API.