GraphQL API

Query related Tasmanian Cloud state through GraphQL

GraphQL is an API surface over the same control-plane state as REST. Use it when a client needs a connected view of a resource, its deployment run, dependencies, events, findings, and outputs.

When to use it

Use REST when a workflow is resource-oriented and each request has a clear boundary. Use GraphQL when the client would otherwise make several related requests and assemble the result itself.

The portal can use a connected query to render a deployment view. An internal service can use the same shape to join resource state with the run and the latest patch findings. The data remains API-owned in both cases.

Keep writes explicit

Queries should read the state required by a view or reconciliation loop. Mutations should express an intentional state change. A GraphQL mutation does not bypass the same authentication, tenant scope, authorisation, Saga execution, or event recording used by other API callers.

Pair it with events

Use a webhook as the signal that state changed. Use GraphQL to read the related state required to decide what to do next. This avoids both permanent polling and overloading an event payload with every possible field.

Related