API Reference

Zero Trust

Gateway

Categories

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List categories

client.ZeroTrust.Gateway.Categories.List(ctx, query) (*SinglePage[Category], error)

GET/accounts/{account_id}/gateway/categories

List all categories.

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)

Zero Trust ReadZero Trust Write

ParametersExpand Collapse

query GatewayCategoryListParams

AccountID param.Field[string]

Provide the identifier string.

maxLength32

ReturnsExpand Collapse

type Category struct{…}

ID int64Optional

Identify this category. Only one category per ID.

Beta boolOptional

Indicate whether the category is in beta and subject to change.

Class CategoryClassOptional

Specify which account types can create policies for this category. blocked Blocks unconditionally for all accounts. removalPending Allows removal from policies but disables addition. noBlock Prevents blocking.

One of the following:

const CategoryClassFree CategoryClass = "free"

const CategoryClassPremium CategoryClass = "premium"

const CategoryClassBlocked CategoryClass = "blocked"

const CategoryClassRemovalPending CategoryClass = "removalPending"

const CategoryClassNoBlock CategoryClass = "noBlock"

Description stringOptional

Provide a short summary of domains in the category.

Name stringOptional

Specify the category name.

Subcategories []CategorySubcategoryOptional

Provide all subcategories for this category.

ID int64Optional

Identify this category. Only one category per ID.

Beta boolOptional

Indicate whether the category is in beta and subject to change.

Class CategorySubcategoriesClassOptional

Specify which account types can create policies for this category. blocked Blocks unconditionally for all accounts. removalPending Allows removal from policies but disables addition. noBlock Prevents blocking.

One of the following:

const CategorySubcategoriesClassFree CategorySubcategoriesClass = "free"

const CategorySubcategoriesClassPremium CategorySubcategoriesClass = "premium"

const CategorySubcategoriesClassBlocked CategorySubcategoriesClass = "blocked"

const CategorySubcategoriesClassRemovalPending CategorySubcategoriesClass = "removalPending"

const CategorySubcategoriesClassNoBlock CategorySubcategoriesClass = "noBlock"

Description stringOptional

Provide a short summary of domains in the category.

Name stringOptional

Specify the category name.

List categories

Go

HTTP

TypeScript

Python

Go

Terraform

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/cloudflare-go"
  "github.com/stainless-sdks/cloudflare-go/option"
  "github.com/stainless-sdks/cloudflare-go/zero_trust"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  page, err := client.ZeroTrust.Gateway.Categories.List(context.TODO(), zero_trust.GatewayCategoryListParams{
    AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

200 example

{
  "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": [
    {
      "id": 0,
      "beta": false,
      "class": "premium",
      "description": "Sites related to educational content that are not included in other categories such as Science, Technology or Educational institutions.",
      "name": "Education",
      "subcategories": [
        {
          "id": 0,
          "beta": false,
          "class": "premium",
          "description": "Sites related to educational content that are not included in other categories such as Science, Technology or Educational institutions.",
          "name": "Education"
        }
      ]
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}

Returns Examples

200 example

{
  "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": [
    {
      "id": 0,
      "beta": false,
      "class": "premium",
      "description": "Sites related to educational content that are not included in other categories such as Science, Technology or Educational institutions.",
      "name": "Education",
      "subcategories": [
        {
          "id": 0,
          "beta": false,
          "class": "premium",
          "description": "Sites related to educational content that are not included in other categories such as Science, Technology or Educational institutions.",
          "name": "Education"
        }
      ]
    }
  ],
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}