Get robots.txt rules

client.AIAudit.Robots.Get(ctx, params) (*RobotGetResponse, error)

GET/zones/{zone_id}/ai-audit/robots

Fetches and parses the robots.txt file for a zone or a specific subdomain within the zone. Returns parsed user-agent rules, content signals, and sitemaps.

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 Settings WriteZone Settings Read

ParametersExpand Collapse

params RobotGetParams

ZoneID param.Field[string]

Path param: Identifier of the zone.

Subdomain param.Field[string]Optional

Query param: Optional subdomain to fetch robots.txt for. If omitted, fetches robots.txt for the zone apex domain.

ReturnsExpand Collapse

type RobotGetResponse struct{…}

Parsed robots.txt rules for a single domain.

UserAgents map[string, RobotGetResponseUserAgent]

Map of user-agent string to its parsed rules.

Allow []string

List of allowed path patterns.

Disallow []string

List of disallowed path patterns.

ContentSignals RobotGetResponseUserAgentsContentSignalsOptional

Content signal directives from robots.txt.

AIInput RobotGetResponseUserAgentsContentSignalsAIInputOptional

Whether AI input usage is permitted.

One of the following:

const RobotGetResponseUserAgentsContentSignalsAIInputYes RobotGetResponseUserAgentsContentSignalsAIInput = "yes"

const RobotGetResponseUserAgentsContentSignalsAIInputNo RobotGetResponseUserAgentsContentSignalsAIInput = "no"

AITrain RobotGetResponseUserAgentsContentSignalsAITrainOptional

Whether AI training is permitted.

One of the following:

const RobotGetResponseUserAgentsContentSignalsAITrainYes RobotGetResponseUserAgentsContentSignalsAITrain = "yes"

const RobotGetResponseUserAgentsContentSignalsAITrainNo RobotGetResponseUserAgentsContentSignalsAITrain = "no"

Search RobotGetResponseUserAgentsContentSignalsSearchOptional

Whether search indexing is permitted.

One of the following:

const RobotGetResponseUserAgentsContentSignalsSearchYes RobotGetResponseUserAgentsContentSignalsSearch = "yes"

const RobotGetResponseUserAgentsContentSignalsSearchNo RobotGetResponseUserAgentsContentSignalsSearch = "no"

CrawlDelay float64Optional

Crawl delay in seconds.

Sitemaps []stringOptional

List of sitemap URLs found in robots.txt.

Status int64Optional

HTTP status code from fetching the robots.txt file.

Get robots.txt rules

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/ai_audit"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  robot, err := client.AIAudit.Robots.Get(context.TODO(), ai_audit.RobotGetParams{
    ZoneID: cloudflare.F("zone_id"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", robot.UserAgents)
}

{
  "errors": [],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "userAgents": {
      "foo": {
        "allow": [
          "string"
        ],
        "disallow": [
          "string"
        ],
        "contentSignals": {
          "ai-input": "yes",
          "ai-train": "yes",
          "search": "yes"
        },
        "crawlDelay": 0
      }
    },
    "sitemaps": [
      "string"
    ],
    "status": 0
  }
}

Returns Examples

{
  "errors": [],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "userAgents": {
      "foo": {
        "allow": [
          "string"
        ],
        "disallow": [
          "string"
        ],
        "contentSignals": {
          "ai-input": "yes",
          "ai-train": "yes",
          "search": "yes"
        },
        "crawlDelay": 0
      }
    },
    "sitemaps": [
      "string"
    ],
    "status": 0
  }
}