Skip to main content
GET
Reports whether a newer version of the template is available for an application or a stack, and what the update would change. Nothing is written. There are two routes with the same response: GET /v1/apps/{id}/template/update for an application and GET /v1/stacks/{stack_id}/template/update for a stack. With an API key the scope is templates:read. Workspace members who can read the resource can call it; updating is for the owner (see Update from Template). An application that belongs to a stack made from a template answers for the whole stack, with every service together. A standalone application, or one in a stack assembled by hand, answers alone. Updates are never automatic: they run only when you ask. See Updates and rollback.
string
required
The application ID (on the /v1/apps/{id}/template/update route).
string
required
The stack ID (on the /v1/stacks/{stack_id}/template/update route).

Response

object
What the update would do.

Error Responses

string
The error code indicating the reason for the failure. Possible values:
  • VALIDATION_ERROR: The ID is not valid (400).
  • API_KEY_SCOPE_DENIED: The API key does not have the templates:read scope (403).
  • APP_NOT_FOUND: The application does not exist or is not yours (404).
  • STACK_NOT_FOUND: The stack does not exist or is not yours (404).
  • TEMPLATE_NOT_FOUND: The application or stack did not come from a template (404).
  • INTERNAL_SERVER_ERROR: Unexpected failure (500).
Last modified on October 28, 2026