NGngrok
TLSCertificates

Create

Changed on

Upload a new TLS certificate

post/tls_certificates

Request

  • Base URL
    https://api.ngrok.com
  • URL
    https://api.ngrok.com/tls_certificates
  • Auth
    HTTP bearer

Headers

ngrok-versioninteger required

Request body

descriptionstring

human-readable description of this TLS certificate. optional, max 255 bytes.

metadatastring

arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.

certificate_pemstring required

chain of PEM-encoded certificates, leaf first. See Certificate Bundles.

private_key_pemstring required

private key for the TLS certificate, PEM-encoded. See Private Keys.

Response

Upload a new TLS certificate

idstring

unique identifier for this TLS certificate

uristring

URI of the TLS certificate API resource

created_atstring

timestamp when the TLS certificate was created, RFC 3339 format

descriptionstring

human-readable description of this TLS certificate. optional, max 255 bytes.

metadatastring

arbitrary user-defined machine-readable data of this TLS certificate. optional, max 4096 bytes.

certificate_pemstring

chain of PEM-encoded certificates, leaf first. See Certificate Bundles.

subject_common_namestring

subject common name from the leaf of this TLS certificate

issued_atstring

timestamp (in RFC 3339 format) when this TLS certificate was issued automatically, or null if this certificate was user-uploaded

not_beforestring

timestamp when this TLS certificate becomes valid, RFC 3339 format

not_afterstring

timestamp when this TLS certificate becomes invalid, RFC 3339 format

key_usagesstring[]

set of actions the private key of this TLS certificate can be used for

extended_key_usagesstring[]

extended set of actions the private key of this TLS certificate can be used for

private_key_typestring

type of the private key of this TLS certificate. One of rsa, ecdsa, or ed25519.

issuer_common_namestring

issuer common name from the leaf of this TLS certificate

serial_numberstring

serial number of the leaf of this TLS certificate

subject_organizationstring

subject organization from the leaf of this TLS certificate

subject_organizational_unitstring

subject organizational unit from the leaf of this TLS certificate

subject_localitystring

subject locality from the leaf of this TLS certificate

subject_provincestring

subject province from the leaf of this TLS certificate

subject_countrystring

subject country from the leaf of this TLS certificate

Changes