Get Zero Trust certificate configuration

Deprecated

client.zeroTrust.gateway.configurations.customCertificate.get(, ?): CustomCertificateSettings { enabled, id, binding_status, updated_at } | null

GET/accounts/{account_id}/gateway/configuration/custom_certificate

Retrieve the current Zero Trust certificate configuration.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a 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

ParametersExpand Collapse

params: CustomCertificateGetParams { account_id }

account_id: string

ReturnsExpand Collapse

CustomCertificateSettings { enabled, id, binding_status, updated_at } | null

enabled: boolean | null

Specify whether to enable a custom certificate authority for signing Gateway traffic.

id?: string

Specify the UUID of the certificate (ID from MTLS certificate store).

binding_status?: string

Indicate the internal certificate status.

updated_at?: string

formatdate-time

Get Zero Trust certificate configuration

import Cloudflare from 'cloudflare';

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

const customCertificateSettings =
  await client.zeroTrust.gateway.configurations.customCertificate.get({
    account_id: '699d98642c564d2e855e9661899b7252',
  });

console.log(customCertificateSettings.id);

{
  "enabled": true,
  "id": "d1b364c5-1311-466e-a194-f0e943e0799f",
  "binding_status": "pending_deployment",
  "updated_at": "2019-12-27T18:11:19.117Z"
}

Returns Examples

{
  "enabled": true,
  "id": "d1b364c5-1311-466e-a194-f0e943e0799f",
  "binding_status": "pending_deployment",
  "updated_at": "2019-12-27T18:11:19.117Z"
}