---
title: "List tag definitions"
method: GET
path: "/tags"
tags: ["TagService"]
---

# List tag definitions

`GET /tags`

## Request

- Base URL: `https://csp.infoblox.com/api/atlas-tagging/v2`
- URL: `https://csp.infoblox.com/api/atlas-tagging/v2/tags`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/infoblox/apis/atlas-tagging-api/docs/tags/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a paginated list of tag definitions for the authenticated account. Supports filtering by key, type, and status using Atlas collection operators.

## Query parameters

- `_filter` string
- `_order_by` string
- `_fields` string
- `_offset` integer
- `_limit` integer
- `_page_token` string

## Response `200`

A successful response.

- ServiceListTagsResponse: ListTagsResponse contains the paginated list of tag definitions.
  - `page` ApiPageInfo: PageInfo represents both server-driven and client-driven pagination response. Server-driven pagination is a model in which the server returns some amount of data along with an token indicating there is more data and where subsequent queries can get the next page of data. Client-driven pagination is a model in which rows are addressable by offset and page size (limit).
    - `offset` integer: The service may optionally include the offset of the next page of resources. A null value indicates no more pages.
    - `page_token` string: The service response should contain a string to indicate the next page of resources. A null value indicates no more pages.
    - `size` integer: The service may optionally include the total number of resources being paged.
  - `results` ServiceTag[]: The list of tag definition objects.
    - `compartment_id` string: The compartment ID for multi-tenancy scoping.
    - `created_at` string, date-time: Read-only. Timestamp created_at, equals to time when particular object was created. Format: RFC 3339 (ISO 8601).
    - `deleted_at` string, date-time: Read-only. Timestamp deleted_at, equals to time when particular object was deleted, by default equals to null. Format: RFC 3339 (ISO 8601).
    - `id` string: The resource identifier.
    - `key` string: The tag key. Must be unique within a namespace and account.
    - `namespace` ServiceNamespace
      - `created_at` string, date-time: Read-only. Timestamp created_at, equals to time when particular object was created. Format: RFC 3339 (ISO 8601).
      - `deleted_at` string, date-time: Read-only. Timestamp deleted_at, equals to time when particular object was deleted, by default equals to null. Format: RFC 3339 (ISO 8601).
      - `id` string: The resource identifier.
      - `name` string: Human-readable name for namespace.
      - `type` string: The namespace type. Valid values: "freeform" (default), "locked", "system".
      - `updated_at` string, date-time: Read-only. Timestamp updated_at, equals to time when particular object was updated, by default equals to created_at. Format: RFC 3339 (ISO 8601).
    - `regexp` string: The tag regexp. POSIX regexp string, used for values validation. By default equals to "*" (allow all). Only applies to freeform tags.
    - `regexp_description` string: The regexp_description, optional human-readable description explaining the regexp validation pattern.
    - `status` string: The tag status. Valid values: "active" (default), "revoked" (soft-deleted).
    - `type` string: The tag type. Valid values: "freeform" (default — any value allowed), "restricted" (only predefined values allowed).
    - `updated_at` string, date-time: Read-only. Timestamp updated_at, equals to time when particular object was updated, by default equals to created_at. Format: RFC 3339 (ISO 8601).
    - `values` ServiceValue[]: The values is a repeated value objects which belongs to particular tag. For restricted tags, defines the set of allowed values.
      - `created_at` string, date-time: Read-only. Timestamp created_at, equals to time when particular object was created. Format: RFC 3339 (ISO 8601).
      - `deleted_at` string, date-time: Read-only. Timestamp deleted_at, equals to time when particular object was deleted, by default equals to null. Format: RFC 3339 (ISO 8601).
      - `id` string: The resource identifier.
      - `value` string: The value string. Trimmed of leading/trailing whitespace on input.
    - `version` integer: The version is used for optimistic concurrency control — prevents multiple users from updating the same tag simultaneously. Must match the current server-side version for updates to succeed.

## Other responses

- `default`: An unexpected error response.

---

[API](https://skmtc.dev/infoblox/apis/atlas-tagging-api.md) - [All operations](https://skmtc.dev/infoblox/apis/atlas-tagging-api/llms.txt) - [OpenAPI document](https://skmtc.dev/infoblox/apis/atlas-tagging-api/revisions/4255d62cedc5?raw)