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

# Project detail (branches + live resources)

> **Token scope:** `account` · `org` · `project` — read-only tokens allowed.



## OpenAPI

````yaml /openapi/project.json get /projects/{projectId}
openapi: 3.1.0
info:
  title: InstaCloud API — Project level
  version: 0.1.0
  description: >-
    Endpoints under `/projects/{projectId}`: branches, services, deploys,
    secrets, databases, storage, cron, observability, governance. Callable with
    any token whose binding covers the project.


    Generated from the platform's own OpenAPI document
    (https://api.instacloud.com/openapi.json); see the [API
    overview](/reference/api/overview) for authentication and token scopes.
servers:
  - url: https://api.instacloud.com
    description: InstaCloud
security:
  - bearerAuth: []
tags:
  - name: Projects
    description: Projects inside an organization.
  - name: Branches
    description: >-
      Branch environments of a project: isolated database, storage and compute
      per branch.
  - name: Services
    description: 'Services on a branch: compute, postgres, storage and managed databases.'
  - name: Deploy
    description: Deploy an image or a source to a compute service.
  - name: Compute
    description: Build output of a compute service.
  - name: Secrets
    description: User secrets, service credentials and how they bind into compute env.
  - name: Database
    description: Postgres databases, extensions, credentials and ad-hoc SQL.
  - name: Storage
    description: Objects in a storage service.
  - name: Backups
    description: Database backups and restores.
  - name: Cron
    description: Scheduled HTTP calls against a service or an external URL.
  - name: Observability
    description: Logs, metrics, deploy events and database insight.
  - name: Governance
    description: Per-project agent policy and the approval queue.
  - name: Audit
    description: The project's event timeline, including agent-ingested events.
  - name: Domains
    description: >-
      Domains bought through InstaCloud, bring-your-own zones and their DNS
      records.
  - name: Billing
    description: Usage, cycles, invoices and credits.
  - name: Templates
    description: Deploy a template into a project.
paths:
  /projects/{projectId}:
    get:
      tags:
        - Projects
      summary: Project detail (branches + live resources)
      description: >-
        **Token scope:** `account` · `org` · `project` — read-only tokens
        allowed.
      operationId: getProject
      parameters:
        - schema:
            format: uuid
            type: string
          in: path
          name: projectId
          required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  project:
                    $ref: '#/components/schemas/Project'
                  branches:
                    type: array
                    items:
                      $ref: '#/components/schemas/Branch'
                  resources:
                    type: array
                    items:
                      $ref: '#/components/schemas/Resource'
                  nextActions:
                    type: array
                    items:
                      $ref: '#/components/schemas/NextAction'
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Project:
      type: object
      properties:
        id:
          format: uuid
          type: string
        org_id:
          format: uuid
          type: string
        owner_user_id:
          description: Better Auth user id (opaque string, not a UUID)
          type: string
        name:
          type: string
        status:
          type: string
          enum:
            - active
            - error
            - deleting
            - deleted
        created_at:
          format: date-time
          type: string
    Branch:
      type: object
      properties:
        id:
          format: uuid
          type: string
        project_id:
          format: uuid
          type: string
        name:
          type: string
        parent_branch_id:
          format: uuid
          type:
            - string
            - 'null'
        is_default:
          type: boolean
        status:
          type: string
          enum:
            - creating
            - active
            - error
            - deleting
        created_at:
          format: date-time
          type: string
    Resource:
      description: Public view of a provisioned resource (no credential material).
      type: object
      properties:
        id:
          format: uuid
          type: string
        kind:
          $ref: '#/components/schemas/ResourceKind'
        provider:
          $ref: '#/components/schemas/ComputeProvider'
        name:
          description: >-
            compute group label for a compute resource (kind=fly |
            insta-compute)
          type:
            - string
            - 'null'
        branchId:
          format: uuid
          type:
            - string
            - 'null'
        status:
          type: string
        ref:
          description: >-
            Non-credential identifiers (e.g. fly url, bucket name, database
            project id)
          type: object
          additionalProperties: true
    NextAction:
      type: object
      properties:
        op:
          description: >-
            Neutral logical action id, e.g. "service.add" — NOT an operationId
            or a CLI/MCP tool name; each client maps it to its own surface.
          type: string
        reason:
          description: Natural-language, human/LLM-facing "why do this now".
          type: string
        args:
          description: >-
            Suggested, flat named arguments; "<placeholder>"s where a value is
            unknown.
          type: object
          additionalProperties: true
        gated:
          description: True if the action passes a governance gate.
          type: boolean
      required:
        - op
        - reason
    Error:
      type: object
      properties:
        error:
          type: string
      required:
        - error
    ResourceKind:
      type: string
      enum:
        - neon
        - insta-db
        - s3
        - fly
        - insta-compute
    ComputeProvider:
      description: >-
        Compute plane actually backing a compute resource, derived from its
        provider_ref rather than its kind. Absent when it cannot be determined
        from the row — clients must then assert no provider rather than assume
        one from `kind`.
      type: string
      enum:
        - fly
        - insta-compute
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Session access JWT or an API token (`insta_<prefix>_<secret>`).

````