Sign in

v4

latestOpenAPI 3.0.32026-07-312,317012.2 MB
PKI Subscribers

Update PKI Subscriber

patch/api/v1/pki/subscribers/{subscriberName}

Path parameters

subscriberNamestring required

The name of the PKI subscriber to update.

Request body

projectIdstring required

The ID of the project to update the PKI subscriber in.

caIdstring uuid

The ID of the CA that will issue certificates for the PKI subscriber to update to.

namestring

The name of the PKI subscriber to update to.

commonNamestring

The common name (CN) to be used on certificates issued for this subscriber to update to.

status'active' | 'disabled'

The status of the PKI subscriber to update to. This can be one of active or disabled.

subjectAlternativeNamesstring[]

A comma-delimited list of Subject Alternative Names (SANs) to be used on certificates issued for this subscriber; these can be host names or email addresses.

ttlstring

The time to live for the certificates issued for this subscriber such as 1m, 1h, 1d, 1y, ...

keyUsagesstring[]

The key usage extension to be used on certificates issued for this subscriber to update to.

extendedKeyUsagesstring[]

The extended key usage extension to be used on certificates issued for this subscriber to update to.

enableAutoRenewalboolean

Whether or not to enable auto renewal for the PKI subscriber.

autoRenewalPeriodInDaysnumber

The period in days to auto renew the PKI subscriber's certificates.

Response

Default Response

idstring uuid required
projectIdstring required
caIdstring uuid nullable
namestring required
commonNamestring required
statusstring required
subjectAlternativeNamesstring[] required
ttlstring nullable
keyUsagesstring[] required
extendedKeyUsagesstring[] required
lastOperationStatusstring nullable
lastOperationMessagestring nullable
lastOperationAtstring date-time nullable
enableAutoRenewalboolean
autoRenewalPeriodInDaysnumber nullable
lastAutoRenewAtstring date-time nullable
{"stackTrail":"paths:/api/v1/pki/subscribers/{subscriberName}:patch:responses:200:content:application/json:schema:properties:properties","oasType":"schema","type":"unknown","nullable":true}
supportsImmediateCertIssuanceboolean