Bulk replace label(s) on operation(s) in endpoint management

client.APIGateway.Operations.Labels.BulkUpdate(ctx, params) (*SinglePage[OperationLabelBulkUpdateResponse], error)

PUT/zones/{zone_id}/api_gateway/operations/labels

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

params OperationLabelBulkUpdateParams

ZoneID param.Field[string]

Path param: Identifier.

maxLength32

Managed param.Field[OperationLabelBulkUpdateParamsManaged]

Body param: Managed labels to replace for all affected operations

Labels []string

List of managed label names. Providing an empty array will result in all managed labels being removed from all affected operations

Selector param.Field[OperationLabelBulkUpdateParamsSelector]

Body param: Operation IDs selector

Include OperationLabelBulkUpdateParamsSelectorInclude

OperationIDs []string

User param.Field[OperationLabelBulkUpdateParamsUser]

Body param: User labels to replace for all affected operations

Labels []string

List of user label names. Providing an empty array will result in all user labels being removed from all affected operations

ReturnsExpand Collapse

type OperationLabelBulkUpdateResponse struct{…}

Endpoint string

The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}, during insertion. This will further be Cloudflare-normalized upon insertion. See: https://developers.cloudflare.com/rules/normalization/how-it-works/.

formaturi-template

maxLength4096

Host string

RFC3986-compliant host.

formathostname

maxLength255

LastUpdated Time

formatdate-time

Method OperationLabelBulkUpdateResponseMethod

The HTTP method used to access the endpoint.

One of the following:

const OperationLabelBulkUpdateResponseMethodGet OperationLabelBulkUpdateResponseMethod = "GET"

const OperationLabelBulkUpdateResponseMethodPost OperationLabelBulkUpdateResponseMethod = "POST"

const OperationLabelBulkUpdateResponseMethodHead OperationLabelBulkUpdateResponseMethod = "HEAD"

const OperationLabelBulkUpdateResponseMethodOptions OperationLabelBulkUpdateResponseMethod = "OPTIONS"

const OperationLabelBulkUpdateResponseMethodPut OperationLabelBulkUpdateResponseMethod = "PUT"

const OperationLabelBulkUpdateResponseMethodDelete OperationLabelBulkUpdateResponseMethod = "DELETE"

const OperationLabelBulkUpdateResponseMethodConnect OperationLabelBulkUpdateResponseMethod = "CONNECT"

const OperationLabelBulkUpdateResponseMethodPatch OperationLabelBulkUpdateResponseMethod = "PATCH"

const OperationLabelBulkUpdateResponseMethodTrace OperationLabelBulkUpdateResponseMethod = "TRACE"

OperationID string

UUID.

maxLength36

minLength36

Labels []OperationLabelBulkUpdateResponseLabelOptional

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 OperationLabelBulkUpdateResponseLabelsSource

user - label is owned by the user
managed - label is owned by cloudflare

One of the following:

const OperationLabelBulkUpdateResponseLabelsSourceUser OperationLabelBulkUpdateResponseLabelsSource = "user"

const OperationLabelBulkUpdateResponseLabelsSourceManaged OperationLabelBulkUpdateResponseLabelsSource = "managed"

Bulk replace label(s) on operation(s) in endpoint management

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"),
  )
  page, err := client.APIGateway.Operations.Labels.BulkUpdate(context.TODO(), api_gateway.OperationLabelBulkUpdateParams{
    ZoneID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    Managed: cloudflare.F(api_gateway.OperationLabelBulkUpdateParamsManaged{
      Labels: cloudflare.F([]string{"login"}),
    }),
    Selector: cloudflare.F(api_gateway.OperationLabelBulkUpdateParamsSelector{
      Include: cloudflare.F(api_gateway.OperationLabelBulkUpdateParamsSelectorInclude{
        OperationIDs: cloudflare.F([]string{"f174e90a-fafe-4643-bbbc-4a0ed4fc8415"}),
      }),
    }),
    User: cloudflare.F(api_gateway.OperationLabelBulkUpdateParamsUser{
      Labels: cloudflare.F([]string{"login"}),
    }),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

{
  "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": [
    {
      "endpoint": "/api/v1/users/{var1}",
      "host": "www.example.com",
      "last_updated": "2014-01-01T05:20:00.12345Z",
      "method": "GET",
      "operation_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "labels": [
        {
          "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": [
    {
      "endpoint": "/api/v1/users/{var1}",
      "host": "www.example.com",
      "last_updated": "2014-01-01T05:20:00.12345Z",
      "method": "GET",
      "operation_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
      "labels": [
        {
          "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
}