> ## Documentation Index
> Fetch the complete documentation index at: https://docs.rafftechnologies.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List tags

> List the account's tags with their colour, priority, server count and the firewalls they carry. `data` holds every tag of the account.

`server_count` counts only servers in projects you can see: pass `X-Project-ID` to count one project.

`tags` and `counts` are kept for older clients: they list only the tags on servers you can see. Use `data`.


<sub>Updated November 10, 2026</sub>


## OpenAPI

````yaml GET /api/v1/tags
openapi: 3.0.3
info:
  title: Raff API
  description: >
    REST API for managing cloud infrastructure on Raff.


    ## Authentication

    Most endpoints require authentication via API key. Catalog endpoints under
    `/api/v1/public/` are open and require no authentication.


    ### API Key Authentication

    Include your API key in the `X-API-Key` header:
      ```
      curl -H "X-API-Key: YOUR_API_KEY" https://api.rafftechnologies.com/api/v1/vms
      ```

    ## Catalog

    Use the public catalog endpoints to discover available regions, OS
    templates, and pricing plans before creating resources:

    - `GET /api/v1/public/regions` — list available regions

    - `GET /api/v1/public/templates` — list OS templates (use the `id` as
    `template_id` when creating a VM)

    - `GET /api/v1/public/pricing/vm` — list VM pricing plans (use the `id` as
    `pricing_id` when creating a VM)

    - `GET /api/v1/public/pricing/volume` — volume storage pricing

    - `GET /api/v1/public/pricing/snapshot` — snapshot storage pricing

    - `GET /api/v1/public/pricing/backup` — backup storage pricing

    - `GET /api/v1/public/pricing/ip` — IP address pricing

    - `GET /api/v1/public/pricing/vpn` — VPN gateway and site-to-site tunnel
    pricing

    - `GET /api/v1/public/pricing/database` — managed database pricing (plans,
    high availability, read replicas, extra storage)

    - `GET /api/v1/public/pricing/kubernetes` — managed Kubernetes pricing
    (worker node plans, HA control plane, storage nodes)
  version: 1.0.0
  contact:
    name: Raff Technologies
    url: https://rafftechnologies.com
servers:
  - url: https://api.rafftechnologies.com
    description: Production
security:
  - ApiKeyAuth: []
tags:
  - name: Catalog
    description: >-
      Discover available regions, OS templates, and pricing plans. No
      authentication required.
  - name: Health
    description: Health check endpoints
  - name: Projects
    description: Organize resources into projects for billing and access control
  - name: Virtual Machines
  - name: Kubernetes
    description: >-
      Managed Kubernetes clusters — HA control planes, autoscaling node pools,
      kubeconfig access
  - name: Functions
    description: Deploy and manage serverless functions
  - name: Raff Apps
    description: >-
      Push-to-deploy web services, private services, workers, cron jobs, and
      one-off jobs on the Raff PaaS — with custom domains, environment
      variables, autoscaling, and per-second billing with spend caps
  - name: Managed Databases
    description: >-
      Managed PostgreSQL, MySQL, Valkey, ClickHouse and Kafka with backups, high
      availability, private VPC networking, optional public access over TLS, and
      metrics
  - name: Networking
    description: >-
      Attach and detach VPCs, floating IPs, and security groups to VM network
      interfaces
  - name: Snapshots
    description: Point-in-time copies of VMs and volumes for quick rollback or cloning
  - name: Backups
    description: Scheduled and on-demand VM backups with restore capability
  - name: Backup Schedules
    description: Recurring daily or weekly backup schedules attached to a VM
  - name: SSH Keys
    description: Manage account-level SSH keys for VM provisioning
  - name: Members
    description: Account-level members — invite, list, update role, remove
  - name: Project Members
    description: Members of a specific project — same model as Members but project-scoped
  - name: Roles
    description: Custom roles bundling account or project permissions
  - name: Permissions
    description: List the catalog of permission strings used by roles
  - name: API Keys
    description: Create and manage API keys for programmatic access
  - name: Invitations
    description: Create and cancel email-based invitations to join the account or a project
paths:
  /api/v1/tags:
    get:
      tags:
        - Virtual Machines
      summary: List tags
      description: >
        List the account's tags with their colour, priority, server count and
        the firewalls they carry. `data` holds every tag of the account.


        `server_count` counts only servers in projects you can see: pass
        `X-Project-ID` to count one project.


        `tags` and `counts` are kept for older clients: they list only the tags
        on servers you can see. Use `data`.
      operationId: listTags
      parameters:
        - name: X-Project-ID
          in: header
          required: false
          description: >-
            Count servers of this project only. Omit it to count servers of
            every project you can see.
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: The account's tags
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/AccountTag'
                  tags:
                    type: array
                    deprecated: true
                    description: >-
                      Tags on the servers you can see. Kept for older clients;
                      use `data`.
                    items:
                      $ref: '#/components/schemas/VMTag'
                  counts:
                    type: object
                    deprecated: true
                    description: >-
                      Servers per tag name. Kept for older clients; use
                      `server_count` in `data`.
                    additionalProperties:
                      type: integer
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    AccountTag:
      type: object
      description: >-
        A tag of the account. The same tag is shared by every server that has
        it.
      required:
        - id
        - name
        - color
        - priority
        - server_count
        - firewalls
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
          description: Tag ID.
        name:
          type: string
          description: Tag name, unique per account ignoring case.
          example: production
        color:
          $ref: '#/components/schemas/TagColor'
        priority:
          type: integer
          nullable: true
          minimum: 1
          maximum: 9
          description: Priority 1-9, 1 highest. `null` when the tag has none.
          example: 1
        server_count:
          type: integer
          description: Servers with this tag, in the projects you can see.
          example: 4
        firewalls:
          type: array
          description: The firewalls this tag carries, one at most per project.
          items:
            $ref: '#/components/schemas/TagFirewallLink'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    VMTag:
      type: object
      description: Custom tag attached to a VM.
      required:
        - id
        - name
        - priority
        - created_at
      properties:
        id:
          type: string
          description: Unique tag identifier
        name:
          type: string
          description: Tag name
        priority:
          type: integer
          description: Tag priority (ordering)
        color:
          $ref: '#/components/schemas/TagColor'
        created_at:
          type: string
          format: date-time
          description: When the tag was created
    TagColor:
      type: string
      enum:
        - gray
        - red
        - orange
        - amber
        - green
        - blue
        - violet
        - pink
      description: Tag colour.
      example: blue
    TagFirewallLink:
      type: object
      description: >-
        A tag that carries a firewall in one project. Servers of that project
        with the tag get the firewall on their public network interfaces.
      required:
        - tag_id
        - tag_name
        - project_id
        - security_group_id
        - security_group_name
      properties:
        tag_id:
          type: string
          format: uuid
        tag_name:
          type: string
          example: web
        project_id:
          type: string
          format: uuid
          description: The project the link applies to (the firewall's project).
        security_group_id:
          type: string
          format: uuid
          description: Firewall (security group) ID.
        security_group_name:
          type: string
          example: web-server
    Error:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
  responses:
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for authentication. Each key is bound to a specific account.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.