Skip to content

TES API ​

Poiesis serves the GA4GH TES v1.1.0 REST API under /ga4gh/tes/v1.

MethodPathOperation
GET/service-infoGetServiceInfo
GET/tasksListTasks (filters, pagination, view levels)
POST/tasksCreateTask
GET/tasks/{id}GetTask (MINIMAL, BASIC or FULL view)
POST/tasks/{id}:cancelCancelTask

Poiesis's own endpoints live under /poiesis/v1, outside the TES namespace, and are mounted only when auth and API keys are on:

MethodPathOperation
POST/api-keysCreateApiKey
GET/api-keysListApiKeys (yours; ?owner= an owner's, for admins)
DELETE/api-keys/{id}RevokeApiKey
DELETE/api-keys?owner=…RevokeApiKeys (all of an owner's, for admins)

See API keys and Offboarding.

More public routes:

  • GET /.well-known/oauth-protected-resource: RFC 9728 metadata, when auth is on and auth.resource is set (its path, if any, is appended). See Discovery.
  • GET /docs and GET /openapi.json on a running server document both APIs, with an optional login; see From the Swagger UI.
  • GET /healthz, /readyz and /startupz: the Kubernetes probes.

The OpenAPI document below is copied from the GA4GH repository at build time. It is for reference only: the buttons don't call a live server. Implementation-specific changes, if any, are syntactic and stay compliant with the spec.

Loading API documentation...