---
title: Custom CSR Details
---

[Skip to content](#%5Ftop) 

[API Reference](https://developers.cloudflare.com/api/typescript)

[Custom Csrs](https://developers.cloudflare.com/api/typescript/resources/custom%5Fcsrs)

Copy Markdown

Open in **Claude**

Open in **ChatGPT**

Open in **Cursor**

---

**Copy Markdown**

**View as Markdown**

# Custom CSR Details

client.customCsrs.get(stringcustomCsrID, CustomCsrGetParams { account\_id, zone\_id } params?, RequestOptionsoptions?): [CustomCsrGetResponse](https://developers.cloudflare.com/api/typescript/resources/custom%5Fcsrs#%28resource%29%20custom%5Fcsrs%20%3E%20%28model%29%20custom%5Fcsr%5Fget%5Fresponse%20%3E%20%28schema%29) { id, created\_at, key\_type, 11 more } 

GET/{accounts\_or\_zones}/{account\_or\_zone\_id}/custom\_csrs/{custom\_csr\_id}

Retrieve details for a specific custom Certificate Signing Request (CSR).

##### Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/).

**Example:**`Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY`

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

**Example:**`X-Auth-Email: user@example.com`

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

**Example:**`X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194`

##### Accepted Permissions (at least one required)

`Account: SSL and Certificates Read` `Account: SSL and Certificates Write`

##### ParametersExpand Collapse 

customCsrID: string

Custom CSR identifier tag.

maxLength36

params: CustomCsrGetParams { account\_id, zone\_id } 

account\_id?: string

The Account ID to use for this endpoint. Mutually exclusive with the Zone ID.

zone\_id?: string

The Zone ID to use for this endpoint. Mutually exclusive with the Account ID.

##### ReturnsExpand Collapse 

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.

### Custom CSR Details

TypeScript

HTTPHTTP

TypeScriptTypeScript

PythonPython

GoGo

TerraformTerraform

```
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const customCsr = await client.customCsrs.get('7b163417-1d2b-4c84-a38a-2fb7a0cd7752', {
  account_id: 'account_id',
});

console.log(customCsr.id);
```

200 example

```
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "id": "7b163417-1d2b-4c84-a38a-2fb7a0cd7752",
    "created_at": "2024-01-15T10:30:00Z",
    "key_type": "rsa2048",
    "account_tag": "23e087bd19bc1d40ae95b6f297263ceb",
    "common_name": "example.com",
    "country": "US",
    "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIICYzCCAUsCAQAwHj...",
    "description": "CSR for example.com wildcard",
    "locality": "San Francisco",
    "name": "My Custom CSR",
    "organization": "Cloudflare, Inc.",
    "organizational_unit": "Engineering",
    "sans": [
      "example.com",
      "www.example.com"
    ],
    "state": "California"
  }
}
```

##### Returns Examples

200 example

```
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "id": "7b163417-1d2b-4c84-a38a-2fb7a0cd7752",
    "created_at": "2024-01-15T10:30:00Z",
    "key_type": "rsa2048",
    "account_tag": "23e087bd19bc1d40ae95b6f297263ceb",
    "common_name": "example.com",
    "country": "US",
    "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIICYzCCAUsCAQAwHj...",
    "description": "CSR for example.com wildcard",
    "locality": "San Francisco",
    "name": "My Custom CSR",
    "organization": "Cloudflare, Inc.",
    "organizational_unit": "Engineering",
    "sans": [
      "example.com",
      "www.example.com"
    ],
    "state": "California"
  }
}
```