Get Leaked Credential Checks Status

client.leakedCredentialChecks.get(, ?): LeakedCredentialCheckGetResponse { enabled }

GET/zones/{zone_id}/leaked-credential-checks

Retrieves the current status of Leaked Credential Checks.

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

Accepted Permissions (at least one required)

Zone WAF WriteZone WAF ReadAccount WAF WriteAccount WAF Read

ParametersExpand Collapse

params: LeakedCredentialCheckGetParams { zone_id }

zone_id: string

Defines an identifier.

maxLength32

ReturnsExpand Collapse

LeakedCredentialCheckGetResponse { enabled }

Defines the overall status for Leaked Credential Checks.

enabled?: boolean

Determines whether or not Leaked Credential Checks are enabled.

Get Leaked Credential Checks Status

import Cloudflare from 'cloudflare';

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

const leakedCredentialCheck = await client.leakedCredentialChecks.get({
  zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
});

console.log(leakedCredentialCheck.enabled);

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "enabled": true
  },
  "success": true
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "enabled": true
  },
  "success": true
}