API
Everything the interface shows is also available over HTTP. These are the endpoints this instance serves.
STAC catalogue
Browsable metadata for every published datasetopenEO capabilities
What this backend supports, for an openEO clientopenEO collections
The datasets an openEO process graph can loadAPI documentation
Interactive Swagger UI for every endpoint belowOpenAPI schema
The machine-readable description this page is built fromDatasets
What this instance holds, and the metadata for each dataset.
| Method | Path | What it does |
|---|---|---|
GET |
/datasets
|
List managed datasets. |
GET |
/datasets/{dataset_id}
|
Get managed dataset metadata and available versions. |
GET |
/datasets/{dataset_id}/download
|
Download the primary saved file for a dataset, for the one format that is a single file. |
GET |
/datasets/{dataset_id}/thumbnail.png
|
Serve a dataset's thumbnail, the image its STAC collection points at. |
Data sources
What this instance can ingest, and whether each data source is ingestable.
| Method | Path | What it does |
|---|---|---|
GET |
/data-sources
|
Return the available data sources from the registry. |
GET |
/data-sources/{dataset_id}
|
Get a single data source by ID with derived coverage metadata. |
Ingestions
Ingest from a data source into this instance, and follow the job it starts.
| Method | Path | What it does |
|---|---|---|
GET |
/ingestions
|
List ingestion run records for operational and admin use. |
POST |
/ingestions
|
Create or update a managed dataset from a data source and the configured extent. |
DELETE |
/ingestions/jobs/{job_id}
|
Request cooperative cancellation for an async ingestion or sync job. |
GET |
/ingestions/jobs/{job_id}
|
Return the status of an async ingestion or sync job. |
GET |
/ingestions/{ingestion_id}
|
Return the managed dataset view created for a given ingestion. |
Sync
Bring an ingested dataset up to date, or ask what a sync would do.
| Method | Path | What it does |
|---|---|---|
POST |
/sync/{dataset_id}
|
Sync a managed dataset forward from its latest available time step. |
GET |
/sync/{dataset_id}/plan
|
Return the sync plan for a managed dataset without starting a download. |
Features
Feature collections as GeoParquet, and refreshing one from its data source.
| Method | Path | What it does |
|---|---|---|
GET |
/features
|
List the feature collections this instance holds. |
GET |
/features/{collection_id}
|
Return one registered feature collection. |
GET |
/features/{collection_id}/data.parquet
|
Serve the GeoParquet a published collection is stored as. |
POST |
/features/{collection_id}/refresh
|
Fetch a feature collection from its template's provider, creating or replacing it. |
Zarr
The datasets themselves, as Zarr over HTTP for any Zarr-aware client.
| Method | Path | What it does |
|---|---|---|
GET |
/zarr/{dataset_id}/{relative_path}
|
Serve canonical Zarr store content for a managed dataset. |
HEAD |
/zarr/{dataset_id}/{relative_path}
|
Serve canonical Zarr store content for a managed dataset. |
Icechunk
The same stores for the Icechunk SDK, with version history.
| Method | Path | What it does |
|---|---|---|
GET |
/icechunk/{dataset_id}/{file_path}
|
Serve a raw Icechunk store file for native SDK access. |
HEAD |
/icechunk/{dataset_id}/{file_path}
|
Serve a raw Icechunk store file for native SDK access. |
STAC
Catalogue metadata for discovery, one collection per published dataset.
| Method | Path | What it does |
|---|---|---|
GET |
/stac
|
Return the STAC catalog landing page. |
GET |
/stac/catalog.json
|
Return the STAC catalog landing page (catalog.json alias). |
GET |
/stac/collections/{dataset_id}
|
Return one STAC collection document. |
openEO
Process graphs: collections, processes, stored workflows, jobs and synchronous results.
| Method | Path | What it does |
|---|---|---|
GET |
/.well-known/openeo
|
OpenEO service discovery — lets clients find the versioned API URL. |
GET |
/collections
|
Return all published collections (openEO + STAC compatible). |
GET |
/collections/{collection_id}
|
Return one published collection. |
GET |
/credentials/oidc
|
Return OIDC authentication providers (empty = open/anonymous access). |
GET |
/file_formats
|
Return supported input and output file formats. |
GET |
/jobs
|
Return all openEO jobs. |
POST |
/jobs
|
Create a new openEO job. |
DELETE |
/jobs/{job_id}
|
Delete a job and its results. |
GET |
/jobs/{job_id}
|
Return one openEO job. |
PATCH |
/jobs/{job_id}
|
Update job metadata (title, description, process, etc.). |
DELETE |
/jobs/{job_id}/results
|
Cancel a running or queued job. |
GET |
/jobs/{job_id}/results
|
Return result links for a finished job. |
POST |
/jobs/{job_id}/results
|
Queue a job for processing. |
GET |
/jobs/{job_id}/results/result.geojson
|
Serve the GeoJSON result file for a finished batch job. |
GET |
/jobs/{job_id}/results/result.zarr/{zarr_path}
|
Serve one file from within the Zarr result store (chunk or metadata). |
GET |
/jobs/{job_id}/results/{filename}
|
Serve a result file (NetCDF, GeoTIFF, PNG, CSV, GeoParquet) for a finished batch job. |
GET |
/me
|
Return basic account info for this open/anonymous backend. |
GET |
/process_graphs
|
Return all stored workflows (user-defined processes). |
DELETE |
/process_graphs/{process_graph_id}
|
Delete a workflow (user-defined process). |
GET |
/process_graphs/{process_graph_id}
|
Return one workflow (user-defined process). |
PUT |
/process_graphs/{process_graph_id}
|
Store or replace a workflow (user-defined process). |
GET |
/processes
|
Return all available openEO processes. |
GET |
/processes/{process_id}
|
Return one openEO process description by id. |
POST |
/result
|
Execute a process graph synchronously and return the result. |
GET |
/service_types
|
Return supported secondary web service types (none currently). |
Extent
The area this instance covers.
| Method | Path | What it does |
|---|---|---|
GET |
/extent
|
Return the configured extent for this Open Climate Service instance. |
Schedules
Scheduled dataset refreshes, as configured for this instance.
| Method | Path | What it does |
|---|---|---|
GET |
/schedules
|
Return configured schedules with process-local runtime status. |
Exports
Deliver an export to its destination, and follow the delivery job.
| Method | Path | What it does |
|---|---|---|
POST |
/exports/{export_id}
|
Queue delivery of a completed source job's saved export payload. |
GET |
/exports/{export_id}/jobs/{delivery_job_id}
|
Return one delivery job's status and, when finished, its export report. |
System
Health, version and the landing page's JSON form.
| Method | Path | What it does |
|---|---|---|
GET |
/
|
Return openEO capabilities (JSON) or the landing page (HTML). |
GET |
/health
|
Return health status for container health checks. |
GET |
/info
|
Return application version and environment info. |