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

projectIdstring uuid required

Query parameters

reveal'0' | '1' | 'true' | 'false'

Include generated passwords (needs env:reveal; audited)

Response

Install status

projectIdstring uuid required
templateIdstring required
templateNamestring required
kind'starter' | 'service' | 'wordpress' | 'repository' required
state'provisioning' | 'configuring' | 'ready' | 'failed' required
errorstring nullable required
urlstring nullable required

the project URL (default hostname or primary custom domain)

adminUrlstring nullable required
adminSetup'none' | 'first-visit' | 'credentials' | 'default-credentials' | 'installer' required
notesstring[] required
createdAtstring required

ISO-8601 timestamp

updatedAtstring required

ISO-8601 timestamp

Changes

No recorded changes to this operation across all 1 revision of this API.