API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Custom Csrs

List Custom CSRs

client.customCsrs.list(CustomCsrListParams { account_id, zone_id, page, per_page } params?, RequestOptionsoptions?): V4PagePaginationArray<CustomCsrListResponse { id, created_at, key_type, 11 more } >

GET/{accounts_or_zones}/{account_or_zone_id}/custom_csrs

Create Custom CSR

client.customCsrs.create(CustomCsrCreateParams { common_name, country, locality, 9 more } params, RequestOptionsoptions?): CustomCsrCreateResponse { id, created_at, key_type, 11 more }

POST/{accounts_or_zones}/{account_or_zone_id}/custom_csrs

Custom CSR Details

client.customCsrs.get(stringcustomCsrId, CustomCsrGetParams { account_id, zone_id } params?, RequestOptionsoptions?): CustomCsrGetResponse { id, created_at, key_type, 11 more }

GET/{accounts_or_zones}/{account_or_zone_id}/custom_csrs/{custom_csr_id}

Delete Custom CSR

client.customCsrs.delete(stringcustomCsrId, CustomCsrDeleteParams { account_id, zone_id } params?, RequestOptionsoptions?): CustomCsrDeleteResponse { id }

DELETE/{accounts_or_zones}/{account_or_zone_id}/custom_csrs/{custom_csr_id}

ModelsExpand Collapse

CustomCsr { id, created_at, key_type, 8 more }

A custom Certificate Signing Request (CSR).

id: string

Custom CSR identifier tag.

maxLength36

created_at: string

When the CSR was created.

formatdate-time

key_type: "rsa2048" | "p256v1"

The key algorithm used to generate the CSR.

One of the following:

"rsa2048"

"p256v1"

common_name?: string

The common name (domain) for the CSR.

maxLength64

country?: string

Two-letter ISO 3166-1 alpha-2 country code.

csr?: string

The PEM-encoded Certificate Signing Request.

locality?: string

City or locality name.

organization?: string

Organization name.

organizational_unit?: string

Organizational unit for the CSR subject.

sans?: Array<string>

Subject Alternative Names included in the CSR.

state?: string

State or province name.

CustomCsrListResponse { id, created_at, key_type, 11 more }

A custom Certificate Signing Request (CSR).

id: string

Custom CSR identifier tag.

maxLength36

created_at: string

When the CSR was created.

formatdate-time

key_type: "rsa2048" | "p256v1"

The key algorithm used to generate the CSR.

One of the following:

"rsa2048"

"p256v1"

account_tag?: string

Account identifier associated with this CSR.

common_name?: string

The common name (domain) for the CSR.

maxLength64

country?: string

Two-letter ISO 3166-1 alpha-2 country code.

csr?: string

The PEM-encoded Certificate Signing Request.

description?: string

Optional description for the CSR.

locality?: string

City or locality name.

name?: string

Human-readable name for the CSR.

organization?: string

Organization name.

organizational_unit?: string

Organizational unit name.

sans?: Array<string>

Subject Alternative Names included in the CSR.

state?: string

State or province name.

CustomCsrCreateResponse { id, created_at, key_type, 11 more }

A custom Certificate Signing Request (CSR).

id: string

Custom CSR identifier tag.

maxLength36

created_at: string

When the CSR was created.

formatdate-time

key_type: "rsa2048" | "p256v1"

The key algorithm used to generate the CSR.

One of the following:

"rsa2048"

"p256v1"

account_tag?: string

Account identifier associated with this CSR.

common_name?: string

The common name (domain) for the CSR.

maxLength64

country?: string

Two-letter ISO 3166-1 alpha-2 country code.

csr?: string

The PEM-encoded Certificate Signing Request.

description?: string

Optional description for the CSR.

locality?: string

City or locality name.

name?: string

Human-readable name for the CSR.

organization?: string

Organization name.

organizational_unit?: string

Organizational unit name.

sans?: Array<string>

Subject Alternative Names included in the CSR.

state?: string

State or province name.

CustomCsrGetResponse { id, created_at, key_type, 11 more }

A custom Certificate Signing Request (CSR).

id: string

Custom CSR identifier tag.

maxLength36

created_at: string

When the CSR was created.

formatdate-time

key_type: "rsa2048" | "p256v1"

The key algorithm used to generate the CSR.

One of the following:

"rsa2048"

"p256v1"

account_tag?: string

Account identifier associated with this CSR.

common_name?: string

The common name (domain) for the CSR.

maxLength64

country?: string

Two-letter ISO 3166-1 alpha-2 country code.

csr?: string

The PEM-encoded Certificate Signing Request.

description?: string

Optional description for the CSR.

locality?: string

City or locality name.

name?: string

Human-readable name for the CSR.

organization?: string

Organization name.

organizational_unit?: string

Organizational unit name.

sans?: Array<string>

Subject Alternative Names included in the CSR.

state?: string

State or province name.

CustomCsrDeleteResponse { id }

id?: string

Custom CSR identifier tag.

maxLength36