Cloudflare API | Rulesets

Mass URL Redirects Write Mass URL Redirects Read Magic Firewall Write Magic Firewall Read L4 DDoS Managed Ruleset Write L4 DDoS Managed Ruleset Read Transform Rules Write Transform Rules Read Select Configuration Write Select Configuration Read Account WAF Write Account WAF Read Account Rulesets Read Account Rulesets Write Logs Write Logs Read

Parameters

rulesetId: string

The unique ID of the ruleset.

params:

RulesetGetParams

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.

Returns

RulesetGetResponse{

A ruleset object.

id: string

The unique ID of the ruleset.

kind:

Kind

The kind of the ruleset.

last_updated: string

(format: date-time)

The timestamp of when the ruleset was last modified.

name: string

(minLength: 1)

The human-readable name of the ruleset.

phase:

Phase

The phase of the ruleset.

rules: Array<

BlockRule

RulesetsChallengeRule

CompressResponseRule

| 15 more...>

The list of rules in the ruleset.

version: string

The version of the ruleset.

description?: string

An informative description of the ruleset.

Request example

import Cloudflare from 'cloudflare';

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

const ruleset = await client.rulesets.get('2f2feab2026849078ba485f918791bdc', {
  account_id: 'account_id',
});

console.log(ruleset.id);

200Example

{
  "errors": [
    {
      "message": "something bad happened",
      "code": 10000,
      "source": {
        "pointer": "/rules/0/action"
      }
    }
  ],
  "messages": [
    {
      "message": "something bad happened",
      "code": 10000,
      "source": {
        "pointer": "/rules/0/action"
      }
    }
  ],
  "result": {
    "id": "2f2feab2026849078ba485f918791bdc",
    "kind": "root",
    "last_updated": "2000-01-01T00:00:00.000000Z",
    "name": "My ruleset",
    "phase": "http_request_firewall_custom",
    "rules": [
      {
        "last_updated": "2000-01-01T00:00:00.000000Z",
        "version": "1",
        "id": "3a03d665bac047339bb530ecb439a90d",
        "action": "block",
        "action_parameters": {
          "response": {
            "content": "{\n  \"success\": false,\n  \"error\": \"you have been blocked\"\n}",
            "content_type": "application/json",
            "status_code": 400
          }
        },
        "categories": [
          "directory-traversal"
        ],
        "description": "Block the request.",
        "enabled": true,
        "exposed_credential_check": {
          "password_expression": "url_decode(http.request.body.form[\\\"password\\\"][0])",
          "username_expression": "url_decode(http.request.body.form[\\\"username\\\"][0])"
        },
        "expression": "ip.src eq 1.1.1.1",
        "logging": {
          "enabled": true
        },
        "ratelimit": {
          "characteristics": [
            "cf.colo.id"
          ],
          "period": 60,
          "counting_expression": "http.request.body.raw eq \"abcd\"",
          "mitigation_timeout": 600,
          "requests_per_period": 1000,
          "requests_to_origin": true,
          "score_per_period": 400,
          "score_response_header_name": "my-score"
        },
        "ref": "my_ref"
      }
    ],
    "version": "1",
    "description": "A description for my ruleset."
  },
  "success": true
}

client.rulesets.create(, ):

RulesetCreateResponse

post/{accounts_or_zones}/{account_or_zone_id}/rulesets

Creates a ruleset.

client.rulesets.update(, , ):

RulesetUpdateResponse

put/{accounts_or_zones}/{account_or_zone_id}/rulesets/{ruleset_id}

Updates an account or zone ruleset, creating a new version.

client.rulesets.delete(, , ): void

delete/{accounts_or_zones}/{account_or_zone_id}/rulesets/{ruleset_id}

Deletes all versions of an existing account or zone ruleset.

Domain types

Kind = "managed" | "custom" | "root" | 1 more...

The kind of the ruleset.

Phase = "ddos_l4" | "ddos_l7" | "http_config_settings" | 20 more...

The phase of the ruleset.

Ruleset{…}

A ruleset object.

Rulesets

Phases

Rulesets.Phases

Methods

client.rulesets.phases.get(, , ):

PhaseGetResponse

get/{accounts_or_zones}/{account_or_zone_id}/rulesets/phases/{ruleset_phase}/entrypoint

Fetches the latest version of the account or zone entry point ruleset for a given phase.

client.rulesets.phases.update(, , ):

PhaseUpdateResponse

put/{accounts_or_zones}/{account_or_zone_id}/rulesets/phases/{ruleset_phase}/entrypoint

Updates an account or zone entry point ruleset, creating a new version.

Rulesets Phases

Versions

Rulesets.Phases.Versions

Methods

client.rulesets.phases.versions.list(, , ):

SinglePage

VersionListResponse

get/{accounts_or_zones}/{account_or_zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions

Fetches the versions of an account or zone entry point ruleset.

client.rulesets.phases.versions.get(, , , ):

VersionGetResponse

get/{accounts_or_zones}/{account_or_zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions/{ruleset_version}

Fetches a specific version of an account or zone entry point ruleset.

Rulesets

Rules

Rulesets.Rules

Methods

client.rulesets.rules.create(, , ):

RuleCreateResponse

post/{accounts_or_zones}/{account_or_zone_id}/rulesets/{ruleset_id}/rules

Adds a new rule to an account or zone ruleset. The rule will be added to the end of the existing list of rules in the ruleset by default.

client.rulesets.rules.edit(, , , ):

RuleEditResponse

patch/{accounts_or_zones}/{account_or_zone_id}/rulesets/{ruleset_id}/rules/{rule_id}

Updates an existing rule in an account or zone ruleset.

client.rulesets.rules.delete(, , , ):

RuleDeleteResponse

delete/{accounts_or_zones}/{account_or_zone_id}/rulesets/{ruleset_id}/rules/{rule_id}

Deletes an existing rule from an account or zone ruleset.

Domain types

BlockRule{…}

CompressResponseRule{…}

DDoSDynamicRule{…}

ExecuteRule{…}

ForceConnectionCloseRule{…}

LogCustomFieldRule{…}

LogRule{…}

Logging{…}

An object configuring the rule's logging behavior.

ManagedChallengeRule{…}

RedirectRule{…}

RewriteRule{…}

RouteRule{…}

RulesetRule{…}

ScoreRule{…}

ServeErrorRule{…}

SetCacheSettingsRule{…}

SetConfigRule{…}

SkipRule{…}

Rulesets

Versions

Rulesets.Versions

Methods

client.rulesets.versions.list(, , ):

SinglePage

VersionListResponse

get/{accounts_or_zones}/{account_or_zone_id}/rulesets/{ruleset_id}/versions

Fetches the versions of an account or zone ruleset.

client.rulesets.versions.get(, , , ):

VersionGetResponse

get/{accounts_or_zones}/{account_or_zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}

Fetches a specific version of an account or zone ruleset.

client.rulesets.versions.delete(, , , ): void

delete/{accounts_or_zones}/{account_or_zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}

Deletes an existing version of an account or zone ruleset.