v1

latestOpenAPI 3.1.02026-07-24317911.4 MB

SSL Certificates

Update SSL certificate for CertManager

put/certificates/{name}

Path parameters

namestring required

Request body

subject-alternative-namestring csv

These are alterntive names that can be included in the certificate, each one comma seperated must be valid and pointed at the cluster

resellerstring required

This is the reseller that owns and has access to the certificate

account-email-addressstring ema required

This is the main email address associated with the certificate request, it will be used to auto create an account with LetsEncrypt

expiration-datetimestring date

The datetime the certificate will expire. Only valid option for 'update' is 0 which will reset the expires time and cause the certificate to be regenerated as soon as possible.

Response

common-namestring hos required

This is the main hostname for the certficate. This must be a FQDN and much post via CNAME or A record to a ip(s) of the cluster

subject-alternative-namestring csv

These are alterntive names that can be included in the certificate, each one comma seperated must be valid and pointed at the cluster

resellerstring required

This is the reseller that owns and has access to the certificate

account-email-addressstring ema required

This is the main email address associated with the certificate request, it will be used to auto create an account with LetsEncrypt

statusstring

This is the status of the certificate request process. Should be "ok" if not in process of upgrading or renewing

generate-datetimestring date

The datetime the certificate was generated

expiration-datetimestring date

The datetime the certificate will expire

challenge-type'http-01' | 'dns-01'

http-01 or dns-01, for most all requests it will be http-01 and you can leave off requests

default-ssl-cert'yes' | 'no'

replicate-ssl-cert'yes' | 'ndp' | 'no'

For most cases this will be "yes" or "ndp" with the later being used to create ndp/endpoint specific certifcates replicated to those servers only.

Example response

[
  {
    "common-name": "portal.example.com"
  }
]