Skip to content
Cloudflare API
Start here
API Reference
API Gateway
Labels
User

Update user label

client.APIGateway.Labels.User.Update(ctx, name, params) (*LabelUserUpdateResponse, error)
PUT/zones/{zone_id}/api_gateway/labels/user/{name}

Update all fields on a label

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)
Account API GatewayDomain API Gateway
ParametersExpand Collapse
name string

The name of the label

params LabelUserUpdateParams
ZoneID param.Field[string]

Path param: Identifier.

maxLength32
Description param.Field[string]Optional

Body param: The description of the label

Metadata param.Field[unknown]Optional

Body param: Metadata for the label

ReturnsExpand Collapse
type LabelUserUpdateResponse struct{…}
CreatedAt Time
formatdate-time
Description string

The description of the label

LastUpdated Time
formatdate-time
Metadata unknown

Metadata for the label

Name string

The name of the label

Source LabelUserUpdateResponseSource
  • user - label is owned by the user
  • managed - label is owned by cloudflare
One of the following:
const LabelUserUpdateResponseSourceUser LabelUserUpdateResponseSource = "user"
const LabelUserUpdateResponseSourceManaged LabelUserUpdateResponseSource = "managed"

Update user label

package main

import (
  "context"
  "fmt"

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

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  user, err := client.APIGateway.Labels.User.Update(
    context.TODO(),
    "login",
    api_gateway.LabelUserUpdateParams{
      ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", user.CreatedAt)
}

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "created_at": "2014-01-01T05:20:00.12345Z",
    "description": "All endpoints that deal with logins",
    "last_updated": "2014-01-01T05:20:00.12345Z",
    "metadata": {
      "foo": "bar"
    },
    "name": "login",
    "source": "user"
  },
  "success": true
}
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"
      }
    }
  ],
  "result": {
    "created_at": "2014-01-01T05:20:00.12345Z",
    "description": "All endpoints that deal with logins",
    "last_updated": "2014-01-01T05:20:00.12345Z",
    "metadata": {
      "foo": "bar"
    },
    "name": "login",
    "source": "user"
  },
  "success": true
}