---
title: Get Keyless SSL Configuration
---

[Skip to content](#%5Ftop) 

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

[Keyless Certificates](https://developers.cloudflare.com/api/typescript/resources/keyless%5Fcertificates)

Copy Markdown

Open in **Claude**

Open in **ChatGPT**

Open in **Cursor**

---

**Copy Markdown**

**View as Markdown**

# Get Keyless SSL Configuration

client.keylessCertificates.get(stringkeylessCertificateID, KeylessCertificateGetParams { zone\_id } params, RequestOptionsoptions?): [KeylessCertificate](https://developers.cloudflare.com/api/typescript/resources/keyless%5Fcertificates#%28resource%29%20keyless%5Fcertificates%20%3E%20%28model%29%20keyless%5Fcertificate%20%3E%20%28schema%29) { id, created\_on, enabled, 7 more } 

GET/zones/{zone\_id}/keyless\_certificates/{keyless\_certificate\_id}

Get details for one Keyless SSL configuration.

##### 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)

`Trust and Safety Write` `Trust and Safety Read` `Zero Trust: PII Read` `Zaraz Edit` `Zaraz Read` `Zaraz Admin` `Access: Apps and Policies Revoke` `Access: Apps and Policies Write` `Access: Apps and Policies Read` `Access: Apps and Policies Revoke` `Access: Mutual TLS Certificates Write` `Access: Organizations, Identity Providers, and Groups Write` `Zone Settings Write` `Zone Settings Read` `Zone Read` `DNS Read` `Workers Scripts Write` `Workers Scripts Read` `Zone Write` `Workers Routes Write` `Workers Routes Read` `Stream Write` `Stream Read` `SSL and Certificates Write` `SSL and Certificates Read` `Logs Write` `Logs Read` `Cache Purge` `Page Rules Write` `Page Rules Read` `Load Balancers Write` `Load Balancers Read` `Firewall Services Write` `Firewall Services Read` `DNS Write` `Apps Write` `Analytics Read` `Access: Apps and Policies Write` `Access: Apps and Policies Read`

##### ParametersExpand Collapse 

keylessCertificateID: string

Identifier.

maxLength32

params: KeylessCertificateGetParams { zone\_id } 

zone\_id: string

Identifier.

maxLength32

##### ReturnsExpand Collapse 

KeylessCertificate { id, created\_on, enabled, 7 more } 

id: string

Keyless certificate identifier tag.

maxLength32

created\_on: string

When the Keyless SSL was created.

formatdate-time

enabled: boolean

Whether or not the Keyless SSL is on or off.

host: string

The keyless SSL name.

formathostname

maxLength253

modified\_on: string

When the Keyless SSL was last modified.

formatdate-time

name: string

The keyless SSL name.

maxLength180

permissions: Array<string\>

Available permissions for the Keyless SSL for the current user requesting the item.

port: number

The keyless SSL port used to communicate between Cloudflare and the client’s Keyless SSL server.

maxLength65535

status: "active" | "deleted"

Status of the Keyless SSL.

One of the following:

"active"

"deleted"

tunnel?: [Tunnel](https://developers.cloudflare.com/api/typescript/resources/keyless%5Fcertificates#%28resource%29%20keyless%5Fcertificates%20%3E%20%28model%29%20tunnel%20%3E%20%28schema%29) { private\_ip, vnet\_id } 

Configuration for using Keyless SSL through a Cloudflare Tunnel.

private\_ip: string

Private IP of the Key Server Host.

vnet\_id: string

Cloudflare Tunnel Virtual Network ID.

### Get Keyless SSL Configuration

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 keylessCertificate = await client.keylessCertificates.get(
  '023e105f4ecef8ad9ca31a8372d0c353',
  { zone_id: '023e105f4ecef8ad9ca31a8372d0c353' },
);

console.log(keylessCertificate.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": "4d2844d2ce78891c34d0b6c0535a291e",
    "created_on": "2014-01-01T05:20:00Z",
    "enabled": false,
    "host": "example.com",
    "modified_on": "2014-01-01T05:20:00Z",
    "name": "example.com Keyless SSL",
    "permissions": [
      "#ssl:read",
      "#ssl:edit"
    ],
    "port": 24008,
    "status": "active",
    "tunnel": {
      "private_ip": "10.0.0.1",
      "vnet_id": "7365377a-85a4-4390-9480-531ef7dc7a3c"
    }
  }
}
```

##### 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": "4d2844d2ce78891c34d0b6c0535a291e",
    "created_on": "2014-01-01T05:20:00Z",
    "enabled": false,
    "host": "example.com",
    "modified_on": "2014-01-01T05:20:00Z",
    "name": "example.com Keyless SSL",
    "permissions": [
      "#ssl:read",
      "#ssl:edit"
    ],
    "port": 24008,
    "status": "active",
    "tunnel": {
      "private_ip": "10.0.0.1",
      "vnet_id": "7365377a-85a4-4390-9480-531ef7dc7a3c"
    }
  }
}
```