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

# Get template deployment

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

Poll a template deployment: status, current step, per-service URLs, and the failure log tail.



## OpenAPI

````yaml /openapi/project.json get /template-deployments/{deploymentId}
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:
  /template-deployments/{deploymentId}:
    get:
      tags:
        - Templates
      summary: Get template deployment
      description: >-
        **Token scope:** `account` · `org` · `project` — read-only tokens
        allowed.


        Poll a template deployment: status, current step, per-service URLs, and
        the failure log tail.
      operationId: getTemplateDeployment
      parameters:
        - schema:
            format: uuid
            type: string
          in: path
          name: deploymentId
          required: true
      responses:
        '200':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateDeployment'
        '404':
          description: Default Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    TemplateDeployment:
      description: One server-side template deployment run and its progress.
      type: object
      properties:
        id:
          format: uuid
          type: string
        status:
          description: >-
            partial = some services came up healthy, others failed — created
            resources are kept either way
          type: string
          enum:
            - running
            - succeeded
            - failed
            - partial
        step:
          description: the pipeline step the run is currently on (or stopped at)
          type: string
          enum:
            - create_services
            - write_variables
            - deploy
            - health_check
        templateCode:
          type: string
        templateVersion:
          type: string
        projectId:
          format: uuid
          type: string
        branchId:
          format: uuid
          type: string
        region:
          description: >-
            InstaCloud region slug every service of this deployment was created
            in. Deployments recorded before regions were recorded read as the
            platform default.
          type: string
        services:
          type: array
          items:
            type: object
            properties:
              name:
                description: >-
                  the service's actual name on the branch, which is the
                  manifest's name only for the first copy — a second deployment
                  of the same template into the same branch names its services
                  <name>-2 and leaves the first copy alone
                type: string
              serviceId:
                format: uuid
                type: string
              url:
                type: string
              state:
                type: string
                enum:
                  - pending
                  - created
                  - deployed
                  - healthy
                  - failed
        error:
          type: string
        logsTail:
          description: container log tail captured when a service never became healthy
          type: string
        createdAt:
          format: date-time
          type: string
    Error:
      type: object
      properties:
        error:
          type: string
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Session access JWT or an API token (`insta_<prefix>_<secret>`).

````