Patch Zero Trust list.

client.ZeroTrust.Gateway.Lists.Edit(ctx, listID, params) (*GatewayList, error)

PATCH/accounts/{account_id}/gateway/lists/{list_id}

Appends or removes an item from a configured Zero Trust list.

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

ParametersExpand Collapse

listID string

Identify the API resource with a UUID.

maxLength36

params GatewayListEditParams

AccountID param.Field[string]

Path param

Append param.Field[[]GatewayListEditParamsAppend]Optional

Body param: Add items to the list.

Description stringOptional

Provide the list item description (optional).

minimum0

Value stringOptional

Specify the item value.

Remove param.Field[[]string]Optional

Body param: Lists of item values you want to remove.

ReturnsExpand Collapse

type GatewayList struct{…}

ID stringOptional

Identify the API resource with a UUID.

maxLength36

Count float64Optional

Indicate the number of items in the list.

CreatedAt TimeOptional

formatdate-time

Description stringOptional

Provide the list description.

Items []GatewayItemOptional

Provide the list items.

CreatedAt TimeOptional

formatdate-time

Description stringOptional

Provide the list item description (optional).

minimum0

Value stringOptional

Specify the item value.

Name stringOptional

Specify the list name.

Type GatewayListTypeOptional

Specify the list type.

One of the following:

const GatewayListTypeSerial GatewayListType = "SERIAL"

const GatewayListTypeURL GatewayListType = "URL"

const GatewayListTypeDomain GatewayListType = "DOMAIN"

const GatewayListTypeEmail GatewayListType = "EMAIL"

const GatewayListTypeIP GatewayListType = "IP"

const GatewayListTypeCategory GatewayListType = "CATEGORY"

const GatewayListTypeLocation GatewayListType = "LOCATION"

const GatewayListTypeDevice GatewayListType = "DEVICE"

const GatewayListTypeAaguid GatewayListType = "AAGUID"

UpdatedAt TimeOptional

formatdate-time

Patch Zero Trust list.

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"),
  )
  gatewayList, err := client.ZeroTrust.Gateway.Lists.Edit(
    context.TODO(),
    "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    zero_trust.GatewayListEditParams{
      AccountID: cloudflare.F("699d98642c564d2e855e9661899b7252"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", gatewayList.ID)
}

{
  "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": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "count": 20,
    "created_at": "2014-01-01T05:20:00.12345Z",
    "description": "The serial numbers for administrators",
    "items": [
      {
        "created_at": "2014-01-01T05:20:00.12345Z",
        "description": "Austin office IP",
        "value": "8GE8721REF"
      }
    ],
    "name": "Admin Serial Numbers",
    "type": "SERIAL",
    "updated_at": "2014-01-01T05:20:00.12345Z"
  }
}

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": {
    "id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "count": 20,
    "created_at": "2014-01-01T05:20:00.12345Z",
    "description": "The serial numbers for administrators",
    "items": [
      {
        "created_at": "2014-01-01T05:20:00.12345Z",
        "description": "Austin office IP",
        "value": "8GE8721REF"
      }
    ],
    "name": "Admin Serial Numbers",
    "type": "SERIAL",
    "updated_at": "2014-01-01T05:20:00.12345Z"
  }
}