Class ApplicationCertificatesClient

sdk.applications.certificates — TLS certificates for an application's hostnames.

Index

Constructors

Methods

getByHostname list refresh reprovision

Constructors

constructor

new ApplicationCertificatesClient(call: Caller): ApplicationCertificatesClient
Parameters
- call: Caller
Returns ApplicationCertificatesClient
- Defined in src/resources/applications.ts:546

Methods

getByHostname

getByHostname(
params: { applicationId: string; hostname: string },
opts?: RequestOptions,
): Promise<GetCertificateResponse>
Certificate for a specific hostname. The backend returns a union: the PEM bundle fields (certificatePem/privateKey/caBundle) when the certificate is issued, or { certificate } data while pending.
Parameters
- params: { applicationId: string; hostname: string }
- Optionalopts: RequestOptions
Returns Promise<GetCertificateResponse>
- Defined in src/resources/applications.ts:562

list

list(
params: { applicationId: string },
opts?: RequestOptions,
): Promise<CertificateData[]>
All certificates for an application.
Parameters
- params: { applicationId: string }
- Optionalopts: RequestOptions
Returns Promise<CertificateData[]>
- Defined in src/resources/applications.ts:549

refresh

refresh(
params: { applicationId: string; certificateId: string },
opts?: RequestOptions,
): Promise<RefreshCertificateResult>
Refresh/renew a certificate; returns the updated certificate row and the backend's CA-order status message when the order is still unresolved (absent once issued). Callers should prefer the real message over any synthesized copy so the user sees the actual CA order state.
Parameters
- params: { applicationId: string; certificateId: string }
- Optionalopts: RequestOptions
Returns Promise<RefreshCertificateResult>
- Defined in src/resources/applications.ts:581

reprovision

reprovision(
params: { applicationId: string; hostname: string },
opts?: RequestOptions,
): Promise<ReprovisionCertificateResult>
Re-provision a TERMINALLY-FAILED certificate (error / expired): a TRUE re-issue that reclaims the dead row and starts a fresh CA order — unlike refresh, which only re-reads the existing order. Use this when a certificate's DNS-01 / HTTPS-file validation failed and the underlying cause (DNS propagation, the device serving the token) is now resolved. Returns the projected status of the reclaimed (freshly pending) certificate. The backend rejects the call (409) when the certificate is not in a terminal state.
Parameters
- params: { applicationId: string; hostname: string }
- Optionalopts: RequestOptions
Returns Promise<ReprovisionCertificateResult>
- Defined in src/resources/applications.ts:610