---
title: "Installation progress and first-login instructions of a project created from a template"
method: GET
path: "/projects/{projectId}/template"
tags: ["Templates"]
---

# Installation progress and first-login instructions of a project created from a template

`GET /projects/{projectId}/template`

## Request

- Base URL: `https://hostingsurge.com/api/v1`
- URL: `https://hostingsurge.com/api/v1/projects/{projectId}/template`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `__Host-hs_session`

## Path parameters

- `projectId` string, uuid, required

## Query parameters

- `reveal` '0' | '1' | 'true' | 'false': Include generated passwords (needs env:reveal; audited)

## Response `200`

Install status

- object
  - `projectId` string, uuid, required
  - `templateId` string, required
  - `templateName` string, required
  - `kind` 'starter' | 'service' | 'wordpress' | 'repository', required
  - `state` 'provisioning' | 'configuring' | 'ready' | 'failed', required
  - `steps` object[], required
    - `key` string, required: stable step id: project, repository, secrets, database, service, deploy, start, configure, ready
    - `label` string, required
    - `state` 'pending' | 'running' | 'done' | 'failed' | 'skipped', required
    - `detail` string, nullable, required
    - `at` string, nullable, required: when the step last changed
  - `error` string, nullable, required
  - `url` string, nullable, required: the project URL (default hostname or primary custom domain)
  - `adminUrl` string, nullable, required
  - `adminSetup` 'none' | 'first-visit' | 'credentials' | 'default-credentials' | 'installer', required
  - `notes` string[], required
  - `credentials` object[], required
    - `label` string, required
    - `username` string, nullable, required
    - `password` string, nullable, required
    - `envKey` string, nullable, required: the environment variable that holds the secret, when it is one (see GET /projects/{id}/env)
  - `createdAt` string, required: ISO-8601 timestamp
  - `updatedAt` string, required: ISO-8601 timestamp

## Other responses

- `400`: Invalid request (code invalid_request)
- `401`: Missing or invalid session/token (code unauthorized)
- `402`: The plan does not allow this template or another project (code limit_reached)
- `403`: Authenticated but not permitted (code forbidden)
- `404`: Not found or not visible to the caller (code not_found)
- `409`: Conflicting state (code conflict)
- `429`: Too many requests (code rate_limited); see Retry-After
- `501`: Templates or a feature they need are not configured on this server (code not_configured)
- `503`: The hosting engine or Git provider is unavailable (code provider_unavailable)

---

[API](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api.md) · [All operations](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/revisions/4d08337cdff1?raw)