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

# Get a resource group by id with member statuses and inherited settings

> Pass includeMetrics=true to enrich each member with 24h uptime, chart data, and latency metrics.



## OpenAPI

````yaml /openapi/monitoring-api.json get /api/v1/resource-groups/{id}
openapi: 3.0.1
info:
  title: DevHelm API
  description: >-
    DevHelm monitoring and incident management API. Create and manage uptime
    monitors, incidents, alert channels, notification policies, and more.
  version: '1.0'
  contact:
    name: DevHelm
    url: https://devhelm.io
    email: support@devhelm.io
servers:
  - url: https://api.devhelm.io
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Alert Channels
    description: Alert channel CRUD and connectivity testing
  - name: Alert Deliveries
    description: 'Delivery audit trail: inspect per-attempt details for alert deliveries'
  - name: API Auth
    description: Identity and quota info for API key authentication
  - name: API Keys
    description: Organization API key management
  - name: Audit Log
    description: Organization audit trail
  - name: Check Results
    description: Query raw check results, uptime statistics, and summary data
  - name: Dashboard
    description: Overview dashboard aggregates
  - name: Deploy Lock
    description: Mutex for CLI deploy operations
  - name: Environments
    description: Variable namespace management for monitors
  - name: Forensics
    description: >-
      Detection engine event-sourced history (policy snapshots, rule
      evaluations, state transitions)
  - name: Heartbeat
    description: Public ping endpoint for heartbeat monitors
  - name: Incident Policies
    description: Manage trigger, confirmation, and recovery rules for monitors
  - name: Incidents
    description: Incident management and lifecycle
  - name: Integrations
    description: Static catalog of supported alert channel integrations
  - name: Invites
    description: Organization invite management
  - name: Maintenance Windows
    description: Schedule alert-suppression windows for monitors
  - name: Members
    description: Organization member management
  - name: Monitor Alert Channels
    description: Manage alert channel mappings for a monitor
  - name: Monitor Assertions
    description: Manage assertions for a monitor
  - name: Monitor Auth
    description: Manage authentication configuration for a monitor
  - name: Monitors
    description: Monitor CRUD and lifecycle management
  - name: Notification Dispatches
    description: >-
      Dispatch debugging API: inspect which policies matched an incident and
      track delivery status
  - name: Notification Policies
    description: Org-level notification routing policies with JSONB match rules
  - name: Notifications
    description: In-app notification center
  - name: Organizations
    description: Organization management
  - name: Resource Groups
    description: Resource group CRUD and member management
  - name: Secrets
    description: Organization environment secret management
  - name: Service Subscriptions
    description: Manage which services an organization tracks
  - name: Status Data
    description: Public service status catalog, components, uptime, and incident history
  - name: Status Pages
    description: Status page management
  - name: Tags
    description: Org-scoped tag management for monitors
  - name: Vault
    description: Organization vault management (admin-only)
  - name: Webhooks
    description: Webhook endpoint management, event catalog, and delivery history
  - name: Workspaces
    description: Workspace management within an organization
paths:
  /api/v1/resource-groups/{id}:
    get:
      tags:
        - Resource Groups
      summary: Get a resource group by id with member statuses and inherited settings
      description: >-
        Pass includeMetrics=true to enrich each member with 24h uptime, chart
        data, and latency metrics.
      operationId: get_3
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: includeMetrics
          in: query
          required: false
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SingleValueResponseResourceGroupDto'
        '400':
          description: Bad request — the payload failed validation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized — missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden — the actor lacks permission for this resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found — the requested resource does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Conflict — the request collides with current resource state
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal server error — see the message field for details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '502':
          description: Bad gateway — an upstream provider returned an error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Service unavailable — try again shortly
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    SingleValueResponseResourceGroupDto:
      required:
        - data
      type: object
      properties:
        data:
          $ref: '#/components/schemas/ResourceGroupDto'
    ErrorResponse:
      required:
        - code
        - message
        - status
        - timestamp
      type: object
      properties:
        status:
          type: integer
          description: HTTP status code (mirrors the response status line)
          format: int32
          example: 404
        code:
          type: string
          description: >-
            Coarse machine-readable error category (e.g. NOT_FOUND,
            RATE_LIMITED); stable per status
          example: NOT_FOUND
        message:
          type: string
          description: Human-readable error message; safe to surface to end users
          example: Monitor not found
        timestamp:
          type: integer
          description: Server time when the error was produced (epoch milliseconds)
          format: int64
          example: 1737302400000
        requestId:
          type: string
          description: >-
            Opaque per-request id; same value as the X-Request-Id response
            header. Use in support tickets.
          nullable: true
          example: 5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a
        errors:
          type: array
          description: >-
            Structured per-field rejections; populated for validation errors,
            null otherwise
          nullable: true
          items:
            nullable: true
            allOf:
              - $ref: '#/components/schemas/ErrorEntry'
      description: Uniform error envelope returned for every non-2xx response
      example:
        status: 404
        code: NOT_FOUND
        message: Monitor not found
        timestamp: 1737302400000
        requestId: 5b6f7a8c-1234-4d5e-9f0a-1b2c3d4e5f6a
    ResourceGroupDto:
      required:
        - createdAt
        - health
        - id
        - name
        - slug
        - updatedAt
        - organizationId
        - suppressMemberAlerts
      type: object
      properties:
        id:
          type: string
          description: Unique resource group identifier
          format: uuid
        organizationId:
          type: integer
          description: Organization this group belongs to
          format: int32
        name:
          minLength: 1
          type: string
          description: Human-readable group name
        slug:
          minLength: 1
          type: string
          description: URL-safe group identifier
        description:
          type: string
          description: Optional group description
          nullable: true
        alertPolicyId:
          type: string
          description: Notification policy applied to this group
          format: uuid
          nullable: true
        defaultFrequency:
          type: integer
          description: Default check frequency in seconds for member monitors
          format: int32
          nullable: true
        defaultRegions:
          type: array
          description: Default regions for member monitors
          nullable: true
          items:
            type: string
            description: Default regions for member monitors
        defaultRetryStrategy:
          nullable: true
          allOf:
            - $ref: '#/components/schemas/RetryStrategy'
        defaultAlertChannels:
          type: array
          description: Default alert channel IDs for member monitors
          nullable: true
          items:
            type: string
            description: Default alert channel IDs for member monitors
            format: uuid
        defaultEnvironmentId:
          type: string
          description: Default environment ID for member monitors
          format: uuid
          nullable: true
        healthThresholdType:
          type: string
          description: 'Health threshold type: COUNT or PERCENTAGE'
          nullable: true
          enum:
            - COUNT
            - PERCENTAGE
        healthThresholdValue:
          type: number
          description: Health threshold value
          nullable: true
        suppressMemberAlerts:
          type: boolean
          description: >-
            When true, member-level incidents skip notification dispatch; only
            group alerts fire
        confirmationDelaySeconds:
          type: integer
          description: >-
            Seconds to wait after health threshold breach before creating group
            incident
          format: int32
          nullable: true
        recoveryCooldownMinutes:
          type: integer
          description: >-
            Cooldown minutes after group incident resolves before a new one can
            open
          format: int32
          nullable: true
        health:
          $ref: '#/components/schemas/ResourceGroupHealthDto'
        members:
          type: array
          description: Member list with individual statuses; populated on detail GET only
          nullable: true
          items:
            $ref: '#/components/schemas/ResourceGroupMemberDto'
        managedBy:
          type: string
          description: >-
            Source that created/owns this group: DASHBOARD, CLI, TERRAFORM, MCP,
            or API. Null on groups created before this attribution column
            existed.
          nullable: true
          enum:
            - DASHBOARD
            - CLI
            - TERRAFORM
            - MCP
            - API
        createdAt:
          type: string
          description: Timestamp when the group was created
          format: date-time
        updatedAt:
          type: string
          description: Timestamp when the group was last updated
          format: date-time
      description: Resource group with health summary and optional member details
    ErrorEntry:
      required:
        - code
        - message
      type: object
      properties:
        code:
          minLength: 1
          type: string
          description: >-
            Stable machine-readable code; see ValidationErrorCode for the
            registry
          example: MONITOR_HEARTBEAT_GRACE_EXCEEDS_INTERVAL
        field:
          type: string
          description: >-
            JSON-pointer-like path to the offending field, or null for
            request-wide errors
          nullable: true
          example: config.gracePeriod
        message:
          minLength: 1
          type: string
          description: Human-readable message; safe to surface to end users
      description: One structured validation rejection
    RetryStrategy:
      required:
        - type
        - maxRetries
        - interval
      type: object
      properties:
        type:
          type: string
          description: Retry strategy kind, e.g. fixed interval between attempts
        maxRetries:
          type: integer
          description: Maximum number of retries after a failed check
          format: int32
        interval:
          type: integer
          description: Delay between retry attempts in seconds
          format: int32
      description: Default retry strategy for member monitors; null clears
    ResourceGroupHealthDto:
      required:
        - status
        - totalMembers
        - operationalCount
        - activeIncidents
      type: object
      properties:
        status:
          type: string
          description: Worst-of health status across all members
          enum:
            - operational
            - maintenance
            - degraded
            - down
        totalMembers:
          type: integer
          description: Total number of members in the group
          format: int32
        operationalCount:
          type: integer
          description: Number of members currently in operational status
          format: int32
        activeIncidents:
          type: integer
          description: Number of members with an active incident or non-operational status
          format: int32
        thresholdStatus:
          type: string
          description: >-
            Computed group health status based on threshold: 'healthy',
            'degraded', or 'down'. Null when no health threshold is configured.
          nullable: true
          enum:
            - healthy
            - degraded
            - down
        failingCount:
          type: integer
          description: Number of failing members at time of last evaluation
          format: int32
          nullable: true
      description: Aggregated health summary for a resource group
    ResourceGroupMemberDto:
      required:
        - createdAt
        - groupId
        - id
        - memberType
        - status
      type: object
      properties:
        id:
          type: string
          description: Unique group member record identifier
          format: uuid
        groupId:
          type: string
          description: Resource group this member belongs to
          format: uuid
        memberType:
          type: string
          description: 'Type of member: ''monitor'' or ''service'''
        monitorId:
          type: string
          description: Monitor ID; set when memberType is 'monitor'
          format: uuid
          nullable: true
        serviceId:
          type: string
          description: Service ID; set when memberType is 'service'
          format: uuid
          nullable: true
        name:
          type: string
          description: Display name of the referenced monitor or service
          nullable: true
        slug:
          type: string
          description: >-
            Slug identifier for the service (services only); used for icons and
            uptime API calls
          nullable: true
        subscriptionId:
          type: string
          description: >-
            Subscription ID for the service (services only); used to link to the
            dependency detail page
          format: uuid
          nullable: true
        status:
          type: string
          description: Computed health status for this member
          enum:
            - operational
            - maintenance
            - degraded
            - down
        effectiveFrequency:
          type: string
          description: >-
            Effective check frequency label showing the group default when the
            monitor inherits it; null for services or when no group default is
            configured
          nullable: true
        createdAt:
          type: string
          description: Timestamp when the member was added to the group
          format: date-time
        uptime24h:
          type: number
          description: 24h uptime percentage; populated when includeMetrics=true
          format: double
          nullable: true
        chartData:
          type: array
          description: >-
            Uptime tick values (0-100) for last-24h mini chart; populated when
            includeMetrics=true
          nullable: true
          items:
            type: number
            description: >-
              Uptime tick values (0-100) for last-24h mini chart; populated when
              includeMetrics=true
            format: double
        avgLatencyMs:
          type: number
          description: >-
            Average latency in ms (monitors only); populated when
            includeMetrics=true
          format: double
          nullable: true
        p95LatencyMs:
          type: number
          description: >-
            P95 latency in ms (monitors only); populated when
            includeMetrics=true
          format: double
          nullable: true
        lastCheckedAt:
          type: string
          description: >-
            Timestamp of the most recent health check; populated when
            includeMetrics=true
          format: date-time
          nullable: true
        monitorType:
          type: string
          description: Monitor type (HTTP, DNS, TCP, ICMP, HEARTBEAT, MCP); monitors only
          nullable: true
        environmentName:
          type: string
          description: Environment name; monitors only
          nullable: true
      description: A single member of a resource group with its computed health status
  securitySchemes:
    BearerAuth:
      type: http
      description: API key (dh_live_...) or Auth0 JWT token
      scheme: bearer
      bearerFormat: JWT

````