Retrieve managed label

client.apiGateway.labels.managed.get(, , ?): ManagedGetResponse { created_at, description, last_updated, 4 more }

GET/zones/{zone_id}/api_gateway/labels/managed/{name}

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 GatewayAccount API Gateway ReadDomain API GatewayDomain API Gateway Read

ParametersExpand Collapse

name: string

The name of the label

params: ManagedGetParams { zone_id, with_mapped_resource_counts }

zone_id: string

Path param: Identifier.

maxLength32

with_mapped_resource_counts?: boolean

Query param: Include mapped_resources for each label

ReturnsExpand Collapse

ManagedGetResponse { created_at, description, last_updated, 4 more }

created_at: string

formatdate-time

description: string

The description of the label

last_updated: string

formatdate-time

metadata: unknown

Metadata for the label

name: string

The name of the label

source: "user" | "managed"

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

One of the following:

"user"

"managed"

mapped_resources?: unknown

Provides counts of what resources are linked to this label

Retrieve managed label

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const managed = await client.apiGateway.labels.managed.get('login', {
  zone_id: '023e105f4ecef8ad9ca31a8372d0c353',
});

console.log(managed.created_at);

{
  "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": "managed",
    "mapped_resources": {
      "operations": 29
    }
  },
  "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": "managed",
    "mapped_resources": {
      "operations": 29
    }
  },
  "success": true
}