Class CertificateActions

Certificate Actions API

Actions are the individual operations that can be performed on a certificate. https://docs.hetzner.cloud/#certificate-actions

Hierarchy (View Summary)

BaseAPI
- CertificateActions

Index

Constructors

Properties

Methods

get getAll getForCertificate listForCertificate request retry

Constructors

constructor

new CertificateActions(token: string, baseUrl?: string): CertificateActions
Parameters
- token: string
- OptionalbaseUrl: string
Returns CertificateActions
Inherited from BaseAPI.constructor
- Defined in base.ts:7

Properties

`Protected`baseUrl

baseUrl: string

`Protected`token

token: string

Methods

get

get(
    actionId: number,
): Promise<
    | { response: CertificateActionResponse; success: true }
    | { response: APIError; success: false },
>
Get a specific action
Parameters
- actionId: number
  The action ID
Returns Promise<
| { response: CertificateActionResponse; success: true }
| { response: APIError; success: false },
>
- Defined in security/actions.ts:67

getAll

getAll(
    params?: ListCertificateActionsParams,
): Promise<
    | { response: CertificateActionsResponse; success: true }
    | { response: APIError; success: false },
>
Get all actions for all certificates
Parameters
- Optionalparams: ListCertificateActionsParams
  Optional parameters for filtering and pagination
Returns Promise<
| { response: CertificateActionsResponse; success: true }
| { response: APIError; success: false },
>
- Defined in security/actions.ts:41

getForCertificate

getForCertificate(
    certificateId: number,
    actionId: number,
): Promise<
    | { response: CertificateActionResponse; success: true }
    | { response: APIError; success: false },
>
Get a specific action for a certificate
Parameters
- certificateId: number
  The certificate ID
- actionId: number
  The action ID
Returns Promise<
| { response: CertificateActionResponse; success: true }
| { response: APIError; success: false },
>
- Defined in security/actions.ts:108

listForCertificate

listForCertificate(
    certificateId: number,
    params?: Omit<ListCertificateActionsParams, "id">,
): Promise<
    | { response: CertificateActionsResponse; success: true }
    | { response: APIError; success: false },
>
Get all actions for a specific certificate
Parameters
- certificateId: number
  The certificate ID
- Optionalparams: Omit<ListCertificateActionsParams, "id">
  Optional parameters for filtering and pagination
Returns Promise<
| { response: CertificateActionsResponse; success: true }
| { response: APIError; success: false },
>
- Defined in security/actions.ts:80

request

request<T>(
    endpoint: string,
    options?: RequestInit,
): Promise<
    { response: T; success: true }
    | { response: APIError; success: false },
>
Type Parameters
- T
Parameters
- endpoint: string
- options: RequestInit = {}
Returns Promise<{ response: T; success: true } | { response: APIError; success: false }>
Inherited from BaseAPI.request
- Defined in base.ts:12

retry

retry(
    certificateId: number,
): Promise<
    | { response: CertificateActionResponse; success: true }
    | { response: APIError; success: false },
>
Retry issuance or renewal of a certificate
Parameters
- certificateId: number
  The certificate ID
Returns Promise<
| { response: CertificateActionResponse; success: true }
| { response: APIError; success: false },
>
- Defined in security/actions.ts:123