List fields

client.logpush.datasets.fields.get(, ?, ?): FieldGetResponse

GET/{accounts_or_zones}/{account_or_zone_id}/logpush/datasets/{dataset_id}/fields

Lists all fields available for a dataset. The response result is. an object with key-value pairs, where keys are field names, and values are descriptions.

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)

Logs Read

ParametersExpand Collapse

datasetID: "access_requests" | "audit_logs" | "audit_logs_v2" | 32 more

Name of the dataset. A list of supported datasets can be found on the Developer Docs.

One of the following:

"access_requests"

"audit_logs"

"audit_logs_v2"

"biso_user_actions"

"casb_findings"

"device_posture_results"

"dex_application_tests"

"dex_device_state_events"

"dlp_forensic_copies"

"dns_firewall_logs"

"dns_logs"

"email_security_alerts"

"email_security_post_delivery_events"

"firewall_events"

"gateway_dns"

"gateway_http"

"gateway_network"

"http_requests"

"ipsec_logs"

"magic_ids_detections"

"mcp_portal_logs"

"mnm_flow_logs"

"nel_reports"

"network_analytics_logs"

"page_shield_events"

"sinkhole_http_logs"

"spectrum_events"

"ssh_logs"

"turnstile_events"

"warp_config_changes"

"warp_toggle_changes"

"websocket_analytics"

"workers_trace_events"

"zaraz_events"

"zero_trust_network_sessions"

params: FieldGetParams { account_id, zone_id }

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.

ReturnsExpand Collapse

FieldGetResponse = unknown

List fields

import Cloudflare from 'cloudflare';

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

const field = await client.logpush.datasets.fields.get('gateway_dns', { account_id: 'account_id' });

console.log(field);

{
  "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": {}
}

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"
      }
    }
  ],
  "success": true,
  "result": {}
}