Skip to content

Endpoints

This page lists all endpoints of the REST API, grouped by topic. Paths are relative to the API base URL, e.g., http://localhost:3030/api. The column Session says whether an endpoint needs a session (yes), works with and without one (optional), or needs none (no); see Authentication. The request and response bodies are described in the OpenAPI specification and the Swagger UI of the server.

Method Path Session Description
POST /cache/clear yes Clear operator results, STAC query metadata and GDAL worker caches.
Method Path Session Description
POST /dataset yes Creates a new dataset referencing files. Users can reference previously uploaded files. Admins can reference files from a volume.
POST /dataset/auto yes Creates a new dataset using previously uploaded files. The format of the files will be automatically detected when possible.
POST /dataset/suggest yes Inspects an upload and suggests metadata that can be used when creating a new dataset based on it. Tries to automatically detect the main file and layer name if not specified.
GET /dataset/volumes yes Lists available volumes.
GET /dataset/volumes/{volume_name}/files/{file_name}/layers yes List the layers of a file in a volume.
GET /dataset/{dataset} yes Retrieves details about a dataset using the internal name.
POST /dataset/{dataset} yes Update details about a dataset using the internal name.
DELETE /dataset/{dataset} yes Delete a dataset
GET /dataset/{dataset}/loadingInfo yes Retrieves the loading information of a dataset
PUT /dataset/{dataset}/loadingInfo yes Updates the dataset’s loading info
PUT /dataset/{dataset}/provenance yes Updates the dataset’s provenance.
PUT /dataset/{dataset}/symbology yes Updates the dataset’s symbology
POST /dataset/{dataset}/tiles yes Add a tile to a gdal dataset.
GET /datasets yes Lists available datasets.
Method Path Session Description
GET /available no Server availablity check.
GET /info no Shows information about the server software version.
Method Path Session Description
PUT /layerDb/collections/{collection} yes Update a collection
DELETE /layerDb/collections/{collection} yes Remove a collection
POST /layerDb/collections/{collection}/collections yes Add a new collection to an existing collection
POST /layerDb/collections/{collection}/layers yes Add a new layer to a collection
POST /layerDb/collections/{collection}/layers/{layer} yes Add an existing layer to a collection
DELETE /layerDb/collections/{collection}/layers/{layer} yes Remove a layer from a collection
POST /layerDb/collections/{parent}/collections/{collection} yes Add an existing collection to a collection
DELETE /layerDb/collections/{parent}/collections/{collection} yes Delete a collection from a collection
PUT /layerDb/layers/{layer} yes Update a layer
DELETE /layerDb/layers/{layer} yes Remove a collection
GET /layerDb/providers yes List all providers
POST /layerDb/providers yes Add a new provider
GET /layerDb/providers/{provider} yes Get an existing provider’s definition
PUT /layerDb/providers/{provider} yes Update an existing provider’s definition
DELETE /layerDb/providers/{provider} yes Delete an existing provider
GET /layers/collections yes List all layer collections
GET /layers/collections/search/autocomplete/{provider}/{collection} yes Autocompletes the search on the contents of the collection of the given provider
GET /layers/collections/search/{provider}/{collection} yes Searches the contents of the collection of the given provider
GET /layers/collections/{provider}/{collection} yes List the contents of the collection of the given provider
GET /layers/{provider}/capabilities yes Returns the capabilities of the given provider, e.g., whether it supports listing and search.
GET /layers/{provider}/{layer} yes Retrieves the layer of the given provider
POST /layers/{provider}/{layer}/dataset yes Persist a raster layer from a provider as a dataset.
POST /layers/{provider}/{layer}/processingGraphId yes Registers a layer from a provider as a processing graph and returns the processing graph id
Method Path Session Description
GET /ml/models yes List ml models.
POST /ml/models yes Create a new ml model.
GET /ml/models/{model_name} yes Get ml model by name.
Method Path Session Description
GET /ogc/{dataConnectorId}/{layerId}/ yes OGC API Landing Page
GET /ogc/{dataConnectorId}/{layerId}/collections yes OGC API Collections List
GET /ogc/{dataConnectorId}/{layerId}/collections/{layerId} yes OGC API Collection Metadata
GET /ogc/{dataConnectorId}/{layerId}/collections/{layerId}/coverage/tiles yes OGC API Collection Coverage Tilesets List
GET /ogc/{dataConnectorId}/{layerId}/collections/{layerId}/coverage/tiles/{tileMatrixSetId} yes OGC API Collection Coverage Tileset Metadata
GET /ogc/{dataConnectorId}/{layerId}/collections/{layerId}/coverage/tiles/{tileMatrixSetId}/{tileMatrix}/{tileRow}/{tileCol} yes OGC API Coverage Tile
GET /ogc/{dataConnectorId}/{layerId}/collections/{layerId}/map/tiles yes OGC API Collection Tilesets List
GET /ogc/{dataConnectorId}/{layerId}/collections/{layerId}/map/tiles/{tileMatrixSetId} yes OGC API Collection Tileset Metadata
GET /ogc/{dataConnectorId}/{layerId}/collections/{layerId}/map/tiles/{tileMatrixSetId}/{tileMatrix}/{tileRow}/{tileCol} yes OGC API Tile
GET /ogc/{dataConnectorId}/{layerId}/conformance yes OGC API Conformance Classes
GET /ogc/{dataConnectorId}/{layerId}/tileMatrixSets yes OGC API Tile Matrix Set List
GET /ogc/{dataConnectorId}/{layerId}/tileMatrixSets/{tileMatrixSetId} yes OGC API Tile Matrix Set Definition
Method Path Session Description
GET /wcs/{processingGraph} yes OGC WCS endpoint
Method Path Session Description
GET /wfs/{processingGraph} yes OGC WFS endpoint
Method Path Session Description
GET /wms/{processingGraph} yes OGC WMS endpoint
Method Path Session Description
PUT /permissions yes Adds a new permission.
DELETE /permissions yes Removes an existing permission.
GET /permissions/resources/{resource_type}/{resource_id} yes Lists permission for a given resource.
Method Path Session Description
GET /plot/{id} yes Generates a plot.
Method Path Session Description
POST /datasetFromProcessingGraph/{id} yes Create a task for creating a new dataset from the result of the processing graph given by its id and the dataset parameters in the request body. Returns the id of the created task
POST /processingGraphs yes Registers a new processing graph.
GET /processingGraphs/{id} yes Retrieves an existing processing graph.
GET /processingGraphs/{id}/allMetadata/zip yes Gets a ZIP archive of the processing graph, its provenance and the output metadata.
GET /processingGraphs/{id}/metadata yes Gets the result metadata of a processing graph
GET /processingGraphs/{id}/provenance yes Gets the provenance of all datasets used in a processing graph.
GET /processingGraphs/{id}/rasterStream yes Query a processing graph raster result as a stream of tiles via a websocket connection.
Method Path Session Description
POST /project yes Create a new project for the user.
GET /project/{project} yes Retrieves details about the latest version of a project.
DELETE /project/{project} yes Deletes a project.
PATCH /project/{project} yes Updates a project. This will create a new version.
GET /project/{project}/versions yes Lists all available versions of a project.
GET /project/{project}/{version} yes Retrieves details about the given version of a project.
GET /projects yes List all projects accessible to the user that match the selected criteria.
Method Path Session Description
POST /anonymous no Creates session for anonymous user. The session’s id serves as a Bearer token for requests.
POST /login no Creates a session by providing user credentials. The session’s id serves as a Bearer token for requests.
POST /logout yes Ends a session.
POST /oidcInit no Initializes the Open Id Connect login procedure by requesting a parametrized url to the configured Id Provider.
POST /oidcLogin no Creates a session for a user via a login with Open Id Connect. This call must be preceded by a call to oidcInit and match the parameters of that call.
GET /session yes Retrieves details about the current session.
POST /session/project/{project} yes Sets the active project of the session.
POST /session/view yes Sets the view (spatial and temporal extent) of the current session.
POST /user no Registers a user.
Method Path Session Description
GET /spatialReferenceSpecification/{srsString} yes Returns the name, PROJ string, extent and axis order of a spatial reference.
Method Path Session Description
GET /tasks/list yes Retrieve the status of all tasks.
DELETE /tasks/{id} yes Abort a running task.
GET /tasks/{id}/status yes Retrieve the status of a task.
Method Path Session Description
POST /upload yes Uploads files.
GET /uploads/{upload_id}/files yes List the files of on upload.
GET /uploads/{upload_id}/files/{file_name}/layers yes List the layers of on uploaded file.
Method Path Session Description
GET /quota yes Retrieves the available and used quota of the current user.
GET /quota/computations yes Retrieves the quota used by computations
GET /quota/computations/{computation} yes Retrieves the quota used by computation with the given computation id
GET /quota/dataUsage yes Retrieves the data usage
GET /quota/dataUsage/summary yes Retrieves the data usage summary
GET /quotas/{user} yes Retrieves the available and used quota of a specific user.
POST /quotas/{user} yes Update the available quota of a specific user.
PUT /roles yes Add a new role. Requires admin privilige.
GET /roles/byName/{name} yes Get role by name
DELETE /roles/{role} yes Remove a role. Requires admin privilige.
GET /user/roles/descriptions yes Query roles for the current user.
POST /users/{user}/roles/{role} yes Assign a role to a user. Requires admin privilige.
DELETE /users/{user}/roles/{role} yes Revoke a role from a user. Requires admin privilige.