Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt

Use this file to discover all available pages before exploring further.

The Cloudflare plugin syncs data locally. Use corsair.cloudflare.db.<entity>.search({ data, limit?, offset? }) with the filters listed per entity.

Dns Records

Path: cloudflare.db.dnsRecords.search
const rows = await corsair.cloudflare.db.dnsRecords.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

FieldTypeOperators
entity_idstringequals, contains, startsWith, endsWith, in
idstringequals, contains, startsWith, endsWith, in
zone_idstringequals, contains, startsWith, endsWith, in
zone_namestringequals, contains, startsWith, endsWith, in
typestringequals, contains, startsWith, endsWith, in
namestringequals, contains, startsWith, endsWith, in
contentstringequals, contains, startsWith, endsWith, in
proxiablebooleanequals
proxiedbooleanequals
ttlnumberequals, gt, gte, lt, lte, in
prioritynumberequals, gt, gte, lt, lte, in
lockedbooleanequals
created_ondateequals, before, after, between
modified_ondateequals, before, after, between
Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.

Rulesets

Path: cloudflare.db.rulesets.search
const rows = await corsair.cloudflare.db.rulesets.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

FieldTypeOperators
entity_idstringequals, contains, startsWith, endsWith, in
idstringequals, contains, startsWith, endsWith, in
zone_idstringequals, contains, startsWith, endsWith, in
namestringequals, contains, startsWith, endsWith, in
descriptionstringequals, contains, startsWith, endsWith, in
kindstringequals, contains, startsWith, endsWith, in
versionstringequals, contains, startsWith, endsWith, in
last_updateddateequals, before, after, between
phasestringequals, contains, startsWith, endsWith, in
Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.

Worker Routes

Path: cloudflare.db.workerRoutes.search
const rows = await corsair.cloudflare.db.workerRoutes.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

FieldTypeOperators
entity_idstringequals, contains, startsWith, endsWith, in
idstringequals, contains, startsWith, endsWith, in
zone_idstringequals, contains, startsWith, endsWith, in
patternstringequals, contains, startsWith, endsWith, in
scriptstringequals, contains, startsWith, endsWith, in
Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.

Worker Scripts

Path: cloudflare.db.workerScripts.search
const rows = await corsair.cloudflare.db.workerScripts.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

FieldTypeOperators
entity_idstringequals, contains, startsWith, endsWith, in
idstringequals, contains, startsWith, endsWith, in
account_idstringequals, contains, startsWith, endsWith, in
created_ondateequals, before, after, between
modified_ondateequals, before, after, between
Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.

Zones

Path: cloudflare.db.zones.search
const rows = await corsair.cloudflare.db.zones.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

FieldTypeOperators
entity_idstringequals, contains, startsWith, endsWith, in
idstringequals, contains, startsWith, endsWith, in
namestringequals, contains, startsWith, endsWith, in
statusstringequals, contains, startsWith, endsWith, in
pausedbooleanequals
typestringequals, contains, startsWith, endsWith, in
created_ondateequals, before, after, between
modified_ondateequals, before, after, between
activated_ondateequals, before, after, between
Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.