PATCH
/
api
/
v1
/
pki
/
subscribers
/
{subscriberName}
cURL
curl --request PATCH \
  --url https://us.infisical.com/api/v1/pki/subscribers/{subscriberName} \
  --header 'Content-Type: application/json' \
  --data '{
  "projectId": "<string>",
  "caId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "commonName": "<string>",
  "status": "active",
  "subjectAlternativeNames": [
    "<string>"
  ],
  "ttl": "<string>",
  "keyUsages": [
    "digitalSignature"
  ],
  "extendedKeyUsages": [
    "clientAuth"
  ],
  "enableAutoRenewal": true,
  "autoRenewalPeriodInDays": 2,
  "properties": {
    "azureTemplateType": "<string>",
    "organization": "<string>",
    "organizationalUnit": "<string>",
    "country": "<string>",
    "state": "<string>",
    "locality": "<string>",
    "emailAddress": "[email protected]"
  }
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "projectId": "<string>",
  "caId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "commonName": "<string>",
  "status": "<string>",
  "subjectAlternativeNames": [
    "<string>"
  ],
  "ttl": "<string>",
  "keyUsages": [
    "<string>"
  ],
  "extendedKeyUsages": [
    "<string>"
  ],
  "lastOperationStatus": "<string>",
  "lastOperationMessage": "<string>",
  "lastOperationAt": "2023-11-07T05:31:56Z",
  "enableAutoRenewal": false,
  "autoRenewalPeriodInDays": 123,
  "lastAutoRenewAt": "2023-11-07T05:31:56Z",
  "properties": "<any>",
  "supportsImmediateCertIssuance": true
}

Path Parameters

​
subscriberName
string
required

The name of the PKI subscriber to update.

Body

application/json
​
projectId
string
required

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

​
caId
string<uuid>

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

Minimum length: 1
​
name
string

The name of the PKI subscriber to update to.

Required string length: 1 - 64
​
commonName
string

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

Minimum length: 1
​
status
enum<string>

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

Available options:
active,
disabled
​
subjectAlternativeNames
string[]

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.

​
ttl
string

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

​
keyUsages
enum<string>[]

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

​
extendedKeyUsages
enum<string>[]

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

​
enableAutoRenewal
boolean

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

​
autoRenewalPeriodInDays
number

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

Required range: x >= 1
​
properties
object

Additional subscriber properties and subject fields

Response

Default Response

​
id
string<uuid>
required
​
projectId
string
required
​
name
string
required
​
commonName
string
required
​
status
string
required
​
subjectAlternativeNames
string[]
required
​
keyUsages
string[]
required
​
extendedKeyUsages
string[]
required
​
caId
string<uuid> | null
​
ttl
string | null
​
lastOperationStatus
string | null
​
lastOperationMessage
string | null
​
lastOperationAt
string<date-time> | null
​
enableAutoRenewal
boolean
default:false
​
autoRenewalPeriodInDays
number | null
​
lastAutoRenewAt
string<date-time> | null
​
properties
any
​
supportsImmediateCertIssuance
boolean