Documentation menu

List templates

GEThttps://api.instacloud.com/templates

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

List published templates in the platform registry. Public — no auth required.

Parameters

NameInTypeRequiredDescription
queryquerystringnosubstring filter over code/name/tagline/tags
categoryquerystringnoexact category filter (case-insensitive)

Responses

200

Default Response

FieldTypeRequiredDescription
templatesobject[]yes
templates.codestringno
templates.versionstringno
templates.maintainerstringnowho publishes it, as the manifest declares ('official' for InstaCloud's own)
templates.sourcestringnothe registry row's publisher tag, set at publish; defaults to the maintainer
templates.namestringno
templates.taglinestringno
templates.categorystringno
templates.tagsstring[]no
templates.totalProjectsintegernodistinct PROJECTS that deployed this template since its first publish (any outcome) — the adoption number; one project deploying repeatedly counts once
templates.activeProjectsintegernodistinct PROJECTS that still have at least one live service from a SUCCEEDED deployment of this template made since its first publish (service in creating/active; deleting, errored or deleted services do not keep a project active) — what a visitor reads as "running this now"
templates.successRateinteger | nullnoshare of the CONCLUDED deployments of this template since its first publish that reached succeeded, as a whole percent. Denominator: deployments with status succeeded + failed + partial, EXCLUDING runs abandoned by a platform restart (a platform release must not count against a template) and excluding running deployments (not concluded). A partial deployment counts as a failure. This is a per-DEPLOYMENT rate, not per attempt: an idempotent retry reuses its deployment row. null (never 0) when nothing has concluded — no data is not 0%
templates.deploymentCountintegernocumulative DEPLOYMENT runs for this code (every run since the template was first published) — the deployment-unit counterpart of totalProjects
templates.activeDeploymentCountintegernoDEPLOYMENT runs since the first publish that succeeded and still have a live attributed service — the deployment-unit counterpart of activeProjects
templates.logoUrlstring | nullnoabsolute https logo URL; null when the template published no logo. Official templates: a commit-pinned jsDelivr URL (TEMPLATE_LOGO_HOST in templateManifest.ts). Community templates: any https:// link the author set.
templates.licensestring | nullnothe upstream project's license id, from the manifest's upstream.license; null when the manifest declares none
templates.updatedAtstringnowhen this template was last published — the catalog freshness stamp

View as Markdown