pki

Activate a pending version with its offline-signed certificate.

Changed on
post/api/v1/instance/pki/issuers/{issuer}/install

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/instance/pki/issuers/{issuer}/install
  • Auth: HTTP bearer

Request body

certificate_pemstring required
chain_pemstring required

The signing chain, ending with the offline root.

Response

The activated version.

idstring required

A prefixed UUIDv7, e.g. org_0198….

namestring required

An issuer or profile name.

versioninteger required
kind'root' | 'intermediate' required
origin'generated' | 'imported' required
parent_idstring nullable
state'pending' | 'active' | 'retiring' | 'retired' | 'revoked' required
key_algorithmstring required
key_fingerprintstring required

sha256:<base64url> of the SubjectPublicKeyInfo.

certificate_pemstring nullable
csr_pemstring nullable

The CSR of a pending version, for an offline root to sign.

chain_pemstring nullable
subject_cnstring required
subject_orgstring nullable
not_beforestring date-time nullable
not_afterstring date-time nullable
crl_distribution_urlstring nullable
restore_holdboolean required

True after a restore until the issuer is reconciled; no issuance while held.

issued_countinteger required
crl_numberinteger required
crl_this_updatestring date-time nullable
crl_next_updatestring date-time nullable
created_atstring date-time required
updated_atstring date-time required

Changes

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      endpoint added