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

# List templates

> The organization's templates, each at its latest revision.



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/templates
openapi: 3.1.0
info:
  title: Bonya Compute REST API
  version: 0.1.0
  description: >
    Public REST and WebSocket surface on TApi behind Caddy. Non-2xx responses
    are RFC 9457 application/problem+json with a stable machine-readable code.
    WebSocket endpoints are HTTP GET upgrades; their options travel in the START
    frame, never in query strings.
servers:
  - url: https://api.bonya.ai
    description: Production
security:
  - personalApiKey: []
  - supabaseJwt: []
tags:
  - name: Sandboxes
    description: Create, look up, list, pause, fork, snapshot, and delete sandboxes.
  - name: Snapshots
    description: Named point-in-time copies of a sandbox that new sandboxes can start from.
  - name: Templates
    description: Saved, versioned launch configurations for sandboxes.
  - name: Registry Connections
    description: Credentials for pulling private container images.
  - name: Secrets
    description: Write-only secrets and secret sets injected into sandboxes and jobs.
  - name: Previews
    description: Expose a sandbox port as an HTTPS URL.
  - name: Exec
    description: Run a command in a sandbox, buffered or over a TTY.
  - name: Sessions
    description: Named, persistent command sessions that outlive a connection.
  - name: Filesystem
    description: Read, write, and manage files inside a sandbox.
  - name: Jobs
    description: Managed, tracked runs of a command or script.
  - name: Job Schedules
    description: Cron, interval, or one-shot timing wrapped around a job.
  - name: Organizations
    description: Organization membership, administration and usage reporting.
  - name: Invitations
    description: Invite members to an organization and accept invitations.
  - name: API Keys
    description: Personal API key management.
  - name: Device Login
    description: Browser-based login for the CLI.
paths:
  /v1/templates:
    get:
      tags:
        - Templates
      summary: List templates
      description: The organization's templates, each at its latest revision.
      operationId: listTemplates
      parameters:
        - $ref: '#/components/parameters/OrganizationHeader'
      responses:
        '200':
          description: Templates
          content:
            application/json:
              schema:
                type: object
                required:
                  - templates
                properties:
                  templates:
                    type: array
                    items:
                      $ref: '#/components/schemas/Template'
        default:
          $ref: '#/components/responses/Problem'
components:
  parameters:
    OrganizationHeader:
      name: X-Bonya-Organization-ID
      in: header
      required: false
      schema:
        type: string
      description: >
        Org context. Omitted means the caller's personal organization. A
        well-formed non-member org is 404; malformed is 400.
  schemas:
    Template:
      type: object
      required:
        - id
        - organization_id
        - name
        - revision
        - config
        - created_at
        - updated_at
      properties:
        id:
          type: string
        organization_id:
          type: string
        name:
          type: string
        description:
          type: string
        revision:
          type: integer
          description: Increases with each published configuration.
        config:
          $ref: '#/components/schemas/TemplateConfig'
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
    TemplateConfig:
      type: object
      additionalProperties: false
      description: Launch configuration. Contains secret references, never values.
      properties:
        image:
          type: string
          description: OCI image reference.
        image_digest:
          type: string
          description: Resolved by the service on save.
        registry_connection_id:
          type: string
        cpu:
          type: integer
        memory_mib:
          type: integer
        disk_gib:
          type: integer
        disk_bytes:
          type: integer
        env:
          type: object
          additionalProperties:
            type: string
        secret_bindings:
          type: object
          additionalProperties:
            type: string
          description: Environment variable name to secret id.
        secret_sets:
          type: array
          items:
            type: string
          description: Secret set names (see /v1/secret-sets).
        secret_set_revisions:
          type: array
          readOnly: true
          description: Pinned by the service on save.
          items:
            type: object
            properties:
              id:
                type: string
              revision:
                type: integer
        entrypoint:
          type:
            - array
            - 'null'
          items:
            type: string
          description: Null inherits the image default; an array overrides it.
        command:
          type:
            - array
            - 'null'
          items:
            type: string
        working_dir:
          type: string
        network:
          $ref: '#/components/schemas/NetworkPolicy'
        previews:
          type: array
          items:
            type: object
            properties:
              port:
                type: integer
              visibility:
                type: string
    Problem:
      type: object
      required:
        - type
        - title
        - status
        - code
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
        code:
          type: string
        detail:
          type: string
    NetworkPolicy:
      type: object
      additionalProperties: false
      required:
        - mode
      properties:
        mode:
          type: string
          enum:
            - open
            - allowlist
            - airgap
          default: open
          description: >-
            open is unrestricted egress; allowlist allows only the listed
            destinations; airgap has no network.
        allow:
          type: array
          maxItems: 64
          items:
            $ref: '#/components/schemas/NetworkRule'
      allOf:
        - if:
            properties:
              mode:
                const: allowlist
          then:
            required:
              - allow
            properties:
              allow:
                minItems: 1
          else:
            properties:
              allow:
                maxItems: 0
    NetworkRule:
      type: object
      additionalProperties: false
      description: Exactly one of domain or cidr. Per-rule ports are not supported yet.
      properties:
        domain:
          type: string
          description: A DNS name such as pypi.org or *.pythonhosted.org.
        cidr:
          type: string
  responses:
    Problem:
      description: RFC 9457 problem
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
  securitySchemes:
    personalApiKey:
      type: http
      scheme: bearer
      description: >-
        Personal byk_ API key; user-principal, resolved to a tenant by org
        context.
    supabaseJwt:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Supabase-issued session JWT; required for org, invite, and key
        management.

````

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