> ## 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.

# Get firewall tags

> The tags this firewall is linked to in its own project, and how far Raff is with putting the firewall on their servers (jobs of the last day, by status).


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


## OpenAPI

````yaml GET /api/v1/security-groups/{id}/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/security-groups/{id}/tags:
    get:
      tags:
        - Networking
      summary: Get firewall tags
      description: >
        The tags this firewall is linked to in its own project, and how far Raff
        is with putting the firewall on their servers (jobs of the last day, by
        status).
      operationId: getFirewallTags
      parameters:
        - $ref: '#/components/parameters/SecurityGroupResourceIDPath'
        - $ref: '#/components/parameters/ProjectIDHeader'
      responses:
        '200':
          description: The firewall's tags and job progress
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    $ref: '#/components/schemas/FirewallTags'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    SecurityGroupResourceIDPath:
      name: id
      in: path
      required: true
      description: Security group ID (UUID).
      schema:
        type: string
        format: uuid
    ProjectIDHeader:
      name: X-Project-ID
      in: header
      required: true
      description: >-
        Project ID. Required for all mutating operations (create, delete, power
        actions, resize).
      schema:
        type: string
        format: uuid
  schemas:
    FirewallTags:
      type: object
      description: >-
        The tags a firewall is linked to in its project, and its jobs of the
        last day by status.
      required:
        - links
        - job_counts
      properties:
        links:
          type: array
          items:
            $ref: '#/components/schemas/TagFirewallLink'
        job_counts:
          type: object
          description: >-
            Server jobs of the last day that put this firewall on servers, by
            status. Statuses with no job are left out.
          properties:
            pending:
              type: integer
            running:
              type: integer
            done:
              type: integer
            failed:
              type: integer
            conflict:
              type: integer
              description: >-
                Servers whose tags carry different firewalls, so nothing was
                changed.
            skipped:
              type: integer
    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'
    NotFound:
      description: Resource not found
      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.