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

# Get App Topology

> Return the grouped topology the dashboard should render.



## OpenAPI

````yaml https://api.getfloo.com/openapi.json get /v1/apps/{app_id}/topology
openapi: 3.1.0
info:
  title: floo API
  version: 0.1.0
servers:
  - url: https://api.getfloo.com
security: []
paths:
  /v1/apps/{app_id}/topology:
    get:
      tags:
        - topology
      summary: Get App Topology
      description: Return the grouped topology the dashboard should render.
      operationId: topology_get_app_topology
      parameters:
        - name: app_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: App Id
        - name: env
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/EnvironmentName'
            default: dev
        - $ref: '#/components/parameters/X-Floo-Org-Id'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppTopologyResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    EnvironmentName:
      type: string
      enum:
        - dev
        - prod
        - preview
      title: EnvironmentName
      description: >-
        Enumerate the persisted development, production, and preview environment
        names.
    AppTopologyResponse:
      properties:
        application_services:
          items:
            $ref: '#/components/schemas/TopologyComponentResponse'
          type: array
          title: Application Services
        managed_services:
          items:
            $ref: '#/components/schemas/TopologyComponentResponse'
          type: array
          title: Managed Services
        effective_status:
          anyOf:
            - type: string
            - type: 'null'
          title: Effective Status
        runtime_status:
          anyOf:
            - type: string
              enum:
                - running
                - starting
                - stopped
                - degraded
            - type: 'null'
          title: Runtime Status
        deploy_status:
          anyOf:
            - type: string
              enum:
                - idle
                - in_progress
                - succeeded
                - failed
            - type: 'null'
          title: Deploy Status
        active_deploy_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Active Deploy Id
        active_deploy_step:
          anyOf:
            - type: string
            - type: 'null'
          title: Active Deploy Step
        last_deploy_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Deploy Id
        last_deploy_outcome:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Deploy Outcome
        last_deploy_failure:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Deploy Failure
        last_deploy_failure_stage:
          anyOf:
            - type: string
            - type: 'null'
          title: Last Deploy Failure Stage
        inferred_health_flags:
          additionalProperties:
            type: boolean
          type: object
          title: Inferred Health Flags
        total:
          type: integer
          title: Total
      type: object
      required:
        - application_services
        - managed_services
        - total
      title: AppTopologyResponse
      description: Grouped topology response for a single app.
    ErrorResponse:
      properties:
        detail:
          $ref: '#/components/schemas/ErrorDetail'
      type: object
      required:
        - detail
      title: ErrorResponse
      description: Body of every error response except request validation (422).
    TopologyComponentResponse:
      properties:
        declared:
          anyOf:
            - type: boolean
            - type: string
              const: unknown
          title: Declared
          default: unknown
        applied:
          anyOf:
            - type: boolean
            - type: string
              const: unknown
          title: Applied
          default: unknown
        id:
          type: string
          format: uuid
          title: Id
        app_id:
          type: string
          format: uuid
          title: App Id
        family:
          type: string
          enum:
            - application
            - managed
          title: Family
        type:
          type: string
          enum:
            - web
            - api
            - worker
            - cron
            - database
            - cache
            - postgres
            - redis
            - storage
          title: Type
        name:
          type: string
          title: Name
        status:
          type: string
          enum:
            - pending
            - deploying
            - running
            - failed
            - stopped
            - provisioning
            - ready
            - backing_up
            - restoring
            - deprovisioning
            - deprovision_failed
          title: Status
        runtime_status:
          anyOf:
            - type: string
              enum:
                - running
                - starting
                - stopped
                - degraded
            - type: 'null'
          title: Runtime Status
        deploy_status:
          anyOf:
            - type: string
              enum:
                - idle
                - in_progress
                - succeeded
                - failed
            - type: 'null'
          title: Deploy Status
        active_deploy_step:
          anyOf:
            - type: string
            - type: 'null'
          title: Active Deploy Step
        ingress:
          anyOf:
            - type: string
              enum:
                - public
                - internal
            - type: 'null'
          title: Ingress
        url:
          anyOf:
            - type: string
            - type: 'null'
          title: Url
        cloud_run_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Cloud Run Url
        image_uri:
          anyOf:
            - type: string
            - type: 'null'
          title: Image Uri
        repo_full_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Repo Full Name
        port:
          anyOf:
            - type: integer
            - type: 'null'
          title: Port
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
        schedule:
          anyOf:
            - type: string
            - type: 'null'
          title: Schedule
        command:
          anyOf:
            - type: string
            - type: 'null'
          title: Command
        timeout:
          anyOf:
            - type: integer
            - type: 'null'
          title: Timeout
        linked_service_id:
          anyOf:
            - type: string
              format: uuid
            - type: 'null'
          title: Linked Service Id
        linked_service_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Linked Service Name
        env_var_keys:
          items:
            type: string
          type: array
          title: Env Var Keys
        last_run_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Run At
        last_run_status:
          anyOf:
            - type: string
              enum:
                - success
                - failed
                - interrupted
            - type: 'null'
          title: Last Run Status
      type: object
      required:
        - id
        - app_id
        - family
        - type
        - name
        - status
        - created_at
        - updated_at
      title: TopologyComponentResponse
      description: Normalized runtime component for the dashboard topology view.
    ErrorDetail:
      properties:
        code:
          type: string
          title: Code
        message:
          type: string
          title: Message
      additionalProperties: true
      type: object
      required:
        - code
        - message
      title: ErrorDetail
      description: Standard error envelope with operation-specific JSON context.
  parameters:
    X-Floo-Org-Id:
      name: X-Floo-Org-Id
      in: header
      required: false
      schema:
        type: string
        format: uuid
      description: Organization to act in; defaults to the one joined most recently.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: A `floo_` API key.

````

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