Honua
// documentation · api reference

The HTTP API, endpoint by endpoint.

← Back to documentation

Provenance: this reference is generated from the live demo server's published OpenAPI documents — trunk, not a versioned release. Documents were fetched from demo.honua.io/docs ↗ (the live API console) on 2026-08-10 (UTC); every document reports info.version 1.0.0. Endpoints can change as trunk moves — the console and the raw documents linked below are always current, this page is a dated snapshot.

Honua publishes 8 OpenAPI documents, one per protocol surface. The six OGC and STAC documents are rendered in full below: 68 operations across 62 paths, each with its parameters, request body, and response codes. The Server Management API document is larger (395 operations across 319 paths), so it is summarized: every operation appears with its method, path, and summary, grouped by tag — parameter and schema detail for those lives in the raw document and the live console. Nothing is omitted from the endpoint listings; only the admin parameter tables are.

Documents published by the server

OpenAPI documents published by the demo server: title, base path, version, operation count, coverage on this page, and raw document link
DocumentBase pathVersionOperationsOn this pageRaw document
OGC API Features/ogc/features1.0.019Full: parameters, bodies, responsesopenapi.json ↗
OGC API Coverages/ogc/coverages1.0.08Full: parameters, bodies, responsesopenapi.json ↗
OGC API Tiles/ogc/tiles1.0.013Full: parameters, bodies, responsesopenapi.json ↗
OGC API Maps/ogc/maps1.0.08Full: parameters, bodies, responsesopenapi.json ↗
OGC API Styles/ogc/styles1.0.00No operations publishedopenapi.json ↗
OGC API Processes/ogc/processes1.0.010Full: parameters, bodies, responsesopenapi.json ↗
STAC API/stac1.0.010Full: parameters, bodies, responsesopenapi.json ↗
Server Management API (admin)/api/v1/admin1.0.0395Summary: method, path, summaryopenapi.json ↗

source: https://demo.honua.io/docs · fetched 2026-08-10 UTC · base URL for every example: https://demo.honua.io

OGC and STAC APIs

Each section starts with the server-reported document description, the base URL, and one runnable request against the public demo server. No authentication is required for the read paths shown in the examples; transactional operations (create, update, delete) require credentials on the demo server.

OGC API Features

OGC API Features implementation for geospatial data access. Mounted at https://demo.honua.io/ogc/features · document version 1.0.0 · raw OpenAPI document ↗

curl -sS "https://demo.honua.io/ogc/features/collections?f=json"

GET /ogc/features/

Get OGC API Features landing page OGC API Features

Parameters for GET /ogc/features/
ParameterInRequiredTypeDescription
fquerynostring (enum: json, html)Output format (json or html)

Responses 200 Landing page information

GET /ogc/features/api

Get OpenAPI 3.0 specification for OGC API Features OGC API Features

No parameters.

Responses 200 OpenAPI specification document · 404 Specification not found

GET /ogc/features/schemas/honua-ogcapi-features.xsd

Get OGC API Features GML application schema OGC API Features

No parameters.

Responses 200 GML application schema

GET /ogc/features/conformance

Get OGC API Features conformance declaration OGC API Features

Parameters for GET /ogc/features/conformance
ParameterInRequiredTypeDescription
fquerynostring (enum: json, html)Output format (json or html)

Responses 200 Conformance declaration

GET /ogc/features/collections

Get OGC API Features collections OGC API Features

Parameters for GET /ogc/features/collections
ParameterInRequiredTypeDescription
fquerynostring (enum: json, html)Output format (json or html)

Responses 200 Collections list

GET /ogc/features/collections/{collectionId}/items

Get features from a collection OGC API Features

Parameters for GET /ogc/features/collections/{collectionId}/items
ParameterInRequiredTypeDescription
collectionIdpathyesstringCollection identifier
fquerynostring (enum: json, geojson, gml, xml, csv, html)Output format (json, geojson, gml, xml, csv, or html)
limitquerynointeger (default 1000; 1–2000)Maximum number of features to return
offsetquerynointeger (min 0)Number of features to skip
bboxquerynoarray<number>Bounding box filter (minx,miny,maxx,maxy or minx,miny,minz,maxx,maxy,maxz)
bbox-crsquerynostring (uri)CRS for the bbox coordinates
crsquerynostring (uri)Coordinate reference system URI for response geometry
datetimequerynostringTemporal filter (RFC 3339 instant or interval)
filterquerynostringCQL2 filter expression
filter-langquerynostring (enum: cql2-text, cql2-json)Filter language (default cql2-text)
filter-crsquerynostring (uri)CRS for filter geometries

Responses 200 FeatureCollection · 400 Invalid request · 404 Collection not found

POST /ogc/features/collections/{collectionId}/items

Create a new feature in a collection OGC API Features · Transactions

Parameters for POST /ogc/features/collections/{collectionId}/items
ParameterInRequiredTypeDescription
collectionIdpathyesstringCollection identifier
Content-Crsheadernostring (uri)Coordinate reference system URI for request geometry. Must be one of the collection-advertised CRSs.

Request body application/geo+json, application/json (required) · GeoJsonFeature

Responses 201 Feature created · 400 Invalid request · 401 Authentication required · 403 Authenticated caller is not authorized to create features in this collection · 404 Collection not found · 409 Conflict

POST /ogc/features/collections/{collectionId}/items/batch

Execute batch feature operations OGC API Features · Transactions · Batch

Parameters for POST /ogc/features/collections/{collectionId}/items/batch
ParameterInRequiredTypeDescription
collectionIdpathyesstringCollection identifier
Content-Crsheadernostring (uri)Coordinate reference system URI applied to every GeoJSON feature in the batch payload. Must be one of the collection-advertised CRSs.

Request body application/json (required) · BatchRequest

Responses 200 Batch operation completed · 207 Batch operation completed with mixed results · 400 Invalid request · 401 Authentication required · 403 Authenticated caller is not authorized to modify this collection · 404 Collection not found

GET /ogc/features/collections/{collectionId}

Get OGC API Features collection metadata OGC API Features

Parameters for GET /ogc/features/collections/{collectionId}
ParameterInRequiredTypeDescription
collectionIdpathyesstringCollection identifier
fquerynostring (enum: json, html)Output format (json or html)

Responses 200 Collection metadata · 404 Collection not found

GET /ogc/features/collections/{collectionId}/queryables

Get queryable properties for a collection OGC API Features

Parameters for GET /ogc/features/collections/{collectionId}/queryables
ParameterInRequiredTypeDescription
collectionIdpathyesstringCollection identifier
fquerynostring (enum: json, schemajson, schema+json, html)Output format (json, schemajson, schema+json, or html)

Responses 200 Queryables schema · 404 Collection not found

GET /ogc/features/collections/{collectionId}/items/{featureId}

Get a specific feature from a collection OGC API Features

Parameters for GET /ogc/features/collections/{collectionId}/items/{featureId}
ParameterInRequiredTypeDescription
collectionIdpathyesstringCollection identifier
featureIdpathyesstringFeature identifier
fquerynostring (enum: json, geojson, gml, xml, csv, html)Output format (json, geojson, gml, xml, csv, or html)
crsquerynostring (uri)Coordinate reference system URI for response geometry

Responses 200 Feature · 404 Feature not found

PUT /ogc/features/collections/{collectionId}/items/{featureId}

Update an existing feature OGC API Features · Transactions

Parameters for PUT /ogc/features/collections/{collectionId}/items/{featureId}
ParameterInRequiredTypeDescription
collectionIdpathyesstringCollection identifier
featureIdpathyesstringFeature identifier
Content-Crsheadernostring (uri)Coordinate reference system URI for request geometry. Must be one of the collection-advertised CRSs.
If-MatchheadernostringStrong ETag from a prior GET item response for optimistic concurrency control.

Request body application/geo+json, application/json (required) · GeoJsonFeature

Responses 200 Feature updated · 400 Invalid request · 401 Authentication required · 403 Authenticated caller is not authorized to replace this feature · 404 Feature not found · 412 ETag precondition failed - the feature has been modified since the provided ETag

PATCH /ogc/features/collections/{collectionId}/items/{featureId}

Partially update an existing feature OGC API Features · Transactions

Parameters for PATCH /ogc/features/collections/{collectionId}/items/{featureId}
ParameterInRequiredTypeDescription
collectionIdpathyesstringCollection identifier
featureIdpathyesstringFeature identifier
Content-Crsheadernostring (uri)Coordinate reference system URI for request geometry. Must be one of the collection-advertised CRSs.
If-MatchheadernostringStrong ETag from a prior GET item response for optimistic concurrency control.

Request body application/geo+json, application/json, application/merge-patch+json (required) · GeoJsonFeature

Responses 200 Feature updated · 400 Invalid request · 401 Authentication required · 403 Authenticated caller is not authorized to patch this feature · 404 Feature not found · 412 ETag precondition failed - the feature has been modified since the provided ETag

DELETE /ogc/features/collections/{collectionId}/items/{featureId}

Delete a feature from a collection OGC API Features · Transactions

Parameters for DELETE /ogc/features/collections/{collectionId}/items/{featureId}
ParameterInRequiredTypeDescription
collectionIdpathyesstringCollection identifier
featureIdpathyesstringFeature identifier

Responses 204 Feature deleted · 400 Invalid request · 401 Authentication required · 403 Authenticated caller is not authorized to delete this feature · 404 Feature not found

GET /ogc/features/collections/{collectionId}/h3

H3 hexagonal grid aggregation for a collection OGC API Features

Parameters for GET /ogc/features/collections/{collectionId}/h3
ParameterInRequiredTypeDescription
collectionIdpathyesstringCollection identifier
resolutionqueryyesinteger (0–15)H3 resolution level (0-15)

Responses 200 H3 aggregation as GeoJSON FeatureCollection · 400 Invalid parameters · 404 Collection not found · 501 H3 extension not available — the h3-pg PostgreSQL extension is not installed · 503 H3 capability check failed — the database may be temporarily unreachable

POST /ogc/features/collections/{collectionId}/clusters

Spatial clustering for a collection (Pro) OGC API Features · Spatial Analytics

Parameters for POST /ogc/features/collections/{collectionId}/clusters
ParameterInRequiredTypeDescription
collectionIdpathyesstringCollection identifier

Request body application/json (required) — Clustering request payload (algorithm, parameters, and optional shared filters)

Responses 200 Cluster assignments or hulls as GeoJSON FeatureCollection · 400 Invalid clustering parameters or filter syntax · 402 Pro-tier license required · 404 Collection not found · 501 Spatial analytics backend not available — the active feature-store provider does not ship a spatial analytics reader (for example, the DuckDB read-only provider). Permanent condition until providers are switched; not a transient failure.

POST /ogc/features/collections/{collectionId}/spatial-join

Spatial join against a target collection (Pro) OGC API Features · Spatial Analytics

Parameters for POST /ogc/features/collections/{collectionId}/spatial-join
ParameterInRequiredTypeDescription
collectionIdpathyesstringSource (target) collection identifier

Request body application/json (required) — Spatial join request payload (join layer id, predicate, optional distance, carry fields, outStatistics, and shared filters)

Responses 200 Joined features as GeoJSON FeatureCollection · 400 Invalid join parameters · 402 Pro-tier license required · 404 Collection not found · 501 Spatial analytics backend not available — the active feature-store provider does not ship a spatial analytics reader (for example, the DuckDB read-only provider). Permanent condition until providers are switched; not a transient failure.

POST /ogc/features/collections/{collectionId}/buffer-aggregate

Buffer + aggregate for a collection (Pro) OGC API Features · Spatial Analytics

Parameters for POST /ogc/features/collections/{collectionId}/buffer-aggregate
ParameterInRequiredTypeDescription
collectionIdpathyesstringCollection identifier

Request body application/json (required) — Buffer aggregate request payload (distance, unit, dissolve flag, optional groupByFields, outStatistics, and shared filters)

Responses 200 Buffered features as GeoJSON FeatureCollection · 400 Invalid buffer parameters · 402 Pro-tier license required · 404 Collection not found · 501 Spatial analytics backend not available — the active feature-store provider does not ship a spatial analytics reader (for example, the DuckDB read-only provider). Permanent condition until providers are switched; not a transient failure.

POST /ogc/features/collections/{collectionId}/density

Density binning for a collection (Pro) OGC API Features · Spatial Analytics

Parameters for POST /ogc/features/collections/{collectionId}/density
ParameterInRequiredTypeDescription
collectionIdpathyesstringCollection identifier

Request body application/json (required) — Density request payload (grid mode, cell size, optional weight field, and shared filters)

Responses 200 Density bins as GeoJSON FeatureCollection · 400 Invalid density parameters · 402 Pro-tier license required · 404 Collection not found · 501 Spatial analytics backend not available — the active feature-store provider does not ship a spatial analytics reader (for example, the DuckDB read-only provider). Permanent condition until providers are switched; not a transient failure.

OGC API Coverages

OGC API Coverages implementation for raster coverage discovery, schema metadata, and coverage retrieval. Mounted at https://demo.honua.io/ogc/coverages · document version 1.0.0 · raw OpenAPI document ↗

curl -sS "https://demo.honua.io/ogc/coverages/collections"

GET /ogc/coverages/

Landing page

Parameters for GET /ogc/coverages/
ParameterInRequiredTypeDescription
fquerynostring (enum: json, html)Metadata representation. Defaults to JSON when no explicit format or Accept header is supplied.

Responses 200 Landing page

GET /ogc/coverages/conformance

Conformance declaration

Parameters for GET /ogc/coverages/conformance
ParameterInRequiredTypeDescription
fquerynostring (enum: json, html)Metadata representation. Defaults to JSON when no explicit format or Accept header is supplied.

Responses 200 Conformance classes

GET /ogc/coverages/api

OpenAPI document

Parameters for GET /ogc/coverages/api
ParameterInRequiredTypeDescription
fquerynostring (enum: json)OpenAPI document representation. Defaults to application/vnd.oai.openapi+json;version=3.0.

Responses 200 OpenAPI document

GET /ogc/coverages/openapi.json

OpenAPI document

Parameters for GET /ogc/coverages/openapi.json
ParameterInRequiredTypeDescription
fquerynostring (enum: json)OpenAPI document representation. Defaults to application/vnd.oai.openapi+json;version=3.0.

Responses 200 OpenAPI document

GET /ogc/coverages/collections

List coverage collections

Parameters for GET /ogc/coverages/collections
ParameterInRequiredTypeDescription
fquerynostring (enum: json, html)Metadata representation. Defaults to JSON when no explicit format or Accept header is supplied.

Responses 200 Accessible raster coverage collections · 400 · 500

GET /ogc/coverages/collections/{collectionId}

Get coverage collection metadata

Parameters for GET /ogc/coverages/collections/{collectionId}
ParameterInRequiredTypeDescription
collectionIdpathyesstring
fquerynostring (enum: json, html)Metadata representation. Defaults to JSON when no explicit format or Accept header is supplied.

Responses 200 Coverage collection metadata · 400 · 404 · 500

GET /ogc/coverages/collections/{collectionId}/schema

Get coverage schema

Parameters for GET /ogc/coverages/collections/{collectionId}/schema
ParameterInRequiredTypeDescription
collectionIdpathyesstring
fquerynostring (enum: json, html)Metadata representation. Defaults to JSON when no explicit format or Accept header is supplied.

Responses 200 Coverage field-selection schema · 400 · 404 · 500

GET /ogc/coverages/collections/{collectionId}/coverage

Get coverage data

Parameters for GET /ogc/coverages/collections/{collectionId}/coverage
ParameterInRequiredTypeDescription
collectionIdpathyesstring
bboxquerynostringSpatial subset as xmin,ymin,xmax,ymax. Coordinates are CRS84 unless bbox-crs is supplied; geographic antimeridian crossings are represented with east/west clip polygons.
bbox-crsquerynostringCRS identifier for bbox coordinates. Must resolve to one of the collection's advertised CRS identifiers.
crsquerynostringOutput CRS identifier. Must resolve to one of the collection's advertised CRS identifiers.
propertiesquerynostringComma-separated band fields, for example band_1,band_3.
resolutionquerynostringPositive native/storage CRS pixel size as one value or width,height. Maps to RasterQuery.PixelSize before output reprojection. The derived output must not exceed 8192 pixels on either axis, checked in storage CRS against the requested bbox when supplied and otherwise against coverage extent or native grid metadata.
scale-factorquerynonumberPositive multiplier for the native pixel size. The derived output must not exceed 8192 pixels on either axis, checked in storage CRS against the requested bbox when supplied and otherwise against coverage extent or native grid metadata.
scale-sizequerynostringOutput size as width,height or axis-size pairs such as x(512),y(512), with each axis from 1 through 8192 pixels.
fquerynostring (enum: geotiff, tiff, tif, image/tiff, png, image/png)Coverage encoding. Defaults to GeoTIFF when no explicit format or Accept header is supplied.

Responses 200 Coverage payload · 400 · 404 · 406 · 500

OGC API Tiles

OGC API Tiles implementation for vector tiles. Mounted at https://demo.honua.io/ogc/tiles · document version 1.0.0 · raw OpenAPI document ↗

curl -sS "https://demo.honua.io/ogc/tiles/tileMatrixSets"

GET /ogc/tiles/

Landing page

Parameters for GET /ogc/tiles/
ParameterInRequiredTypeDescription
fquerynostring (enum: json, html)Output format (json or html)

Responses 200 Landing page information

GET /ogc/tiles/conformance

Conformance declaration

Parameters for GET /ogc/tiles/conformance
ParameterInRequiredTypeDescription
fquerynostring (enum: json, html)Output format (json or html)

Responses 200 Conformance declaration

GET /ogc/tiles/openapi.json

OpenAPI specification

Parameters for GET /ogc/tiles/openapi.json
ParameterInRequiredTypeDescription
fquerynostring (enum: json)Output format (json)

Responses 200 OpenAPI document

GET /ogc/tiles/collections

Collections list

Parameters for GET /ogc/tiles/collections
ParameterInRequiredTypeDescription
fquerynostring (enum: json, html)Output format (json or html)

Responses 200 Collections list · 401 Authentication required to access the available collections · 403 Available collections are not accessible

GET /ogc/tiles/collections/{collectionId}

Collection metadata

Parameters for GET /ogc/tiles/collections/{collectionId}
ParameterInRequiredTypeDescription
collectionIdpathyesinteger (min 0)
fquerynostring (enum: json, html)Output format (json or html)

Responses 200 Collection metadata · 400 Invalid collection metadata query parameters · 401 Authentication required for the requested collection · 403 Requested collection is not accessible · 404 Not found · 406 Requested metadata format is not acceptable

GET /ogc/tiles/tiles

Dataset tilesets list

Parameters for GET /ogc/tiles/tiles
ParameterInRequiredTypeDescription
fquerynostring (enum: json, html)Output format (json or html)

Responses 200 Tilesets list · 400 Invalid tilesets query parameters · 401 Authentication required to access the available dataset tilesets · 403 Available dataset tilesets are not accessible · 406 Requested metadata format is not acceptable

GET /ogc/tiles/tiles/{tileMatrixSetId}

Dataset tileset metadata

Parameters for GET /ogc/tiles/tiles/{tileMatrixSetId}
ParameterInRequiredTypeDescription
tileMatrixSetIdpathyesstring
fquerynostring (enum: json, html)Output format (json or html)
collectionsquerynoarray<string>Comma-separated collection identifiers

Responses 200 Tileset metadata · 400 Invalid tileset query parameters · 401 Authentication required to access the requested dataset tileset · 403 Requested dataset tileset is not accessible · 404 Not found · 406 Requested metadata format is not acceptable

GET /ogc/tiles/tiles/{tileMatrixSetId}/{tileMatrix}/{tileRow}/{tileCol}

Dataset tile

Parameters for GET /ogc/tiles/tiles/{tileMatrixSetId}/{tileMatrix}/{tileRow}/{tileCol}
ParameterInRequiredTypeDescription
tileMatrixSetIdpathyesstring
tileMatrixpathyesstring
tileRowpathyesinteger (min 0)
tileColpathyesinteger (min 0)
fquerynostring (enum: mvt, png)Tile format (mvt or png)
datetimequerynostring
subsetquerynostring
crsquerynostring (uri)
subset-crsquerynostring (uri)
collectionsquerynoarray<string>Comma-separated collection identifiers

Responses 200 Vector or raster tile · 204 No content · 400 Invalid tile matrix, tile coordinates, or query parameters · 401 Authentication required for at least one requested collection · 403 Requested collections are not accessible · 404 Tile matrix set or requested collections not found · 406 Requested tile format is not acceptable

GET /ogc/tiles/collections/{collectionId}/tiles

Collection tilesets list

Parameters for GET /ogc/tiles/collections/{collectionId}/tiles
ParameterInRequiredTypeDescription
collectionIdpathyesinteger (min 0)
fquerynostring (enum: json, html)Output format (json or html)

Responses 200 Tilesets list · 400 Invalid collection tilesets query parameters · 401 Authentication required for the requested collection · 403 Requested collection is not accessible · 404 Not found · 406 Requested metadata format is not acceptable

GET /ogc/tiles/collections/{collectionId}/tiles/{tileMatrixSetId}

Collection tileset metadata

Parameters for GET /ogc/tiles/collections/{collectionId}/tiles/{tileMatrixSetId}
ParameterInRequiredTypeDescription
collectionIdpathyesinteger (min 0)
tileMatrixSetIdpathyesstring
fquerynostring (enum: json, html)Output format (json or html)

Responses 200 Tileset metadata · 400 Invalid collection tileset query parameters · 401 Authentication required for the requested collection · 403 Requested collection is not accessible · 404 Not found · 406 Requested metadata format is not acceptable

GET /ogc/tiles/collections/{collectionId}/tiles/{tileMatrixSetId}/{tileMatrix}/{tileRow}/{tileCol}

Collection tile

Parameters for GET /ogc/tiles/collections/{collectionId}/tiles/{tileMatrixSetId}/{tileMatrix}/{tileRow}/{tileCol}
ParameterInRequiredTypeDescription
collectionIdpathyesinteger (min 0)
tileMatrixSetIdpathyesstring
tileMatrixpathyesstring
tileRowpathyesinteger (min 0)
tileColpathyesinteger (min 0)
fquerynostring (enum: mvt, png)Tile format (mvt or png)
datetimequerynostring
subsetquerynostring
crsquerynostring (uri)
subset-crsquerynostring (uri)

Responses 200 Vector or raster tile · 204 No content · 400 Invalid tile matrix, tile coordinates, or query parameters · 401 Authentication required for the requested collection · 403 Requested collection is not accessible · 404 Collection or tile matrix set not found · 406 Requested tile format is not acceptable

GET /ogc/tiles/tileMatrixSets

Tile matrix sets list

Parameters for GET /ogc/tiles/tileMatrixSets
ParameterInRequiredTypeDescription
fquerynostring (enum: json, html)Output format (json or html)

Responses 200 Tile matrix sets list · 400 Invalid tile matrix sets query parameters · 406 Requested metadata format is not acceptable

GET /ogc/tiles/tileMatrixSets/{tileMatrixSetId}

Tile matrix set definition

Parameters for GET /ogc/tiles/tileMatrixSets/{tileMatrixSetId}
ParameterInRequiredTypeDescription
tileMatrixSetIdpathyesstring
fquerynostring (enum: json, html)Output format (json or html)

Responses 200 Tile matrix set · 400 Invalid tile matrix set query parameters · 404 Not found · 406 Requested metadata format is not acceptable

OGC API Maps

OGC API Maps implementation for server-rendered imagery. Mounted at https://demo.honua.io/ogc/maps · document version 1.0.0 · raw OpenAPI document ↗

curl -sS "https://demo.honua.io/ogc/maps/conformance"

GET /ogc/maps

Get OGC API Maps landing page

No parameters.

Responses 200 Landing page

GET /ogc/maps/conformance

Get OGC API Maps conformance declaration

No parameters.

Responses 200 Conformance declaration

GET /ogc/maps/openapi.json

Get OGC API Maps OpenAPI document

No parameters.

Responses 200 OpenAPI document

GET /ogc/maps/map

Render a dataset map

Parameters for GET /ogc/maps/map
ParameterInRequiredTypeDescription
collectionsquerynostringComma-separated collection identifiers to include in a dataset map request. When omitted, all accessible map-enabled collections are considered.
bboxquerynostringBounding box as minX,minY,maxX,maxY in the bbox-crs coordinate reference system.
bbox-crsquerynostringCoordinate reference system for bbox coordinates. Supports EPSG codes and OGC CRS URIs.
crsquerynostringCoordinate reference system for the rendered map response. Supports EPSG codes and OGC CRS URIs.
widthquerynointeger (1–4096)Rendered image width in pixels.
heightquerynointeger (1–4096)Rendered image height in pixels.
fquerynostring (enum: png, jpeg, jpg, tiff, tif)Short output image format. When omitted, HTTP Accept negotiation is used.
qualityquerynointeger (1–100)Lossy compression quality for JPEG output.
datetimequerynostringRFC 3339 instant or interval used to select temporal raster mosaic frames. Accepts a single instant (e.g. 2024-02-15T00:00:00Z), a closed interval (start/end), and half-open intervals (start/.., ../end). Honua selects the newest effective acquisition batch within the bounded range across the addressed collection or dataset, then applies bbox windowing and renders rasters from that batch only. Requires the raster.temporal-mosaic entitlement; inactive entitlements return 402 Payment Required.

Responses 200 Rendered map image · 400 Invalid map request parameters · 401 Authentication required for at least one requested collection · 402 Payment required when datetime rendering needs the raster.temporal-mosaic entitlement · 403 Requested collections are not accessible · 404 No renderable collections were found

GET /ogc/maps/collections/{collectionId}/map

Render a collection map

Parameters for GET /ogc/maps/collections/{collectionId}/map
ParameterInRequiredTypeDescription
collectionIdpathyesinteger (min 0)
bboxquerynostringBounding box as minX,minY,maxX,maxY in the bbox-crs coordinate reference system.
bbox-crsquerynostringCoordinate reference system for bbox coordinates. Supports EPSG codes and OGC CRS URIs.
crsquerynostringCoordinate reference system for the rendered map response. Supports EPSG codes and OGC CRS URIs.
widthquerynointeger (1–4096)Rendered image width in pixels.
heightquerynointeger (1–4096)Rendered image height in pixels.
fquerynostring (enum: png, jpeg, jpg, tiff, tif)Short output image format. When omitted, HTTP Accept negotiation is used.
qualityquerynointeger (1–100)Lossy compression quality for JPEG output.
datetimequerynostringRFC 3339 instant or interval used to select temporal raster mosaic frames. Accepts a single instant (e.g. 2024-02-15T00:00:00Z), a closed interval (start/end), and half-open intervals (start/.., ../end). Honua selects the newest effective acquisition batch within the bounded range across the addressed collection or dataset, then applies bbox windowing and renders rasters from that batch only. Requires the raster.temporal-mosaic entitlement; inactive entitlements return 402 Payment Required.

Responses 200 Rendered map image · 400 Invalid collection identifier or map request parameters · 401 Authentication required for the requested collection · 402 Payment required when datetime rendering needs the raster.temporal-mosaic entitlement · 403 Requested collection is not accessible · 404 Collection not found or has no renderable map data

GET /ogc/maps/collections/{collectionId}/styles/{styleId}/map

Render a styled collection map

Parameters for GET /ogc/maps/collections/{collectionId}/styles/{styleId}/map
ParameterInRequiredTypeDescription
collectionIdpathyesinteger (min 0)
styleIdpathyesstring
bboxquerynostringBounding box as minX,minY,maxX,maxY in the bbox-crs coordinate reference system.
bbox-crsquerynostringCoordinate reference system for bbox coordinates. Supports EPSG codes and OGC CRS URIs.
crsquerynostringCoordinate reference system for the rendered map response. Supports EPSG codes and OGC CRS URIs.
widthquerynointeger (1–4096)Rendered image width in pixels.
heightquerynointeger (1–4096)Rendered image height in pixels.
fquerynostring (enum: png, jpeg, jpg, tiff, tif)Short output image format. When omitted, HTTP Accept negotiation is used.
qualityquerynointeger (1–100)Lossy compression quality for JPEG output.
datetimequerynostringRFC 3339 instant or interval used to select temporal raster mosaic frames. Accepts a single instant (e.g. 2024-02-15T00:00:00Z), a closed interval (start/end), and half-open intervals (start/.., ../end). Honua selects the newest effective acquisition batch within the bounded range across the addressed collection or dataset, then applies bbox windowing and renders rasters from that batch only. Requires the raster.temporal-mosaic entitlement; inactive entitlements return 402 Payment Required.

Responses 200 Rendered styled map image · 400 Invalid collection identifier or map request parameters · 401 Authentication required for the requested collection · 402 Payment required when datetime rendering needs the raster.temporal-mosaic entitlement · 403 Requested collection is not accessible · 404 Collection not found or has no renderable map data · 501 Styled map rendering is not implemented for this collection type

GET /ogc/maps/collections/{collectionId}/map/tiles

Get collection map tilesets

Parameters for GET /ogc/maps/collections/{collectionId}/map/tiles
ParameterInRequiredTypeDescription
collectionIdpathyesinteger (min 0)

Responses 200 Tileset metadata · 400 Invalid collection identifier · 401 Authentication required for the requested collection · 403 Requested collection is not accessible · 404 Collection not found

GET /ogc/maps/collections/{collectionId}/map/tiles/{tileMatrixSetId}

Get collection map tileset

Parameters for GET /ogc/maps/collections/{collectionId}/map/tiles/{tileMatrixSetId}
ParameterInRequiredTypeDescription
collectionIdpathyesinteger (min 0)
tileMatrixSetIdpathyesstring

Responses 200 Tileset metadata · 400 Invalid collection identifier · 401 Authentication required for the requested collection · 403 Requested collection is not accessible · 404 Collection or tile matrix set not found

OGC API Processes

OGC API Processes adapter over the Honua canonical geoprocessing runtime. Mounted at https://demo.honua.io/ogc/processes · document version 1.0.0 · raw OpenAPI document ↗

curl -sS "https://demo.honua.io/ogc/processes/processes"

GET /ogc/processes

OGC API Processes landing page

Parameters for GET /ogc/processes
ParameterInRequiredTypeDescription
fquerynostring (enum: json, html)Metadata response format.

Responses 200 Landing page

GET /ogc/processes/conformance

OGC API Processes conformance declaration

Parameters for GET /ogc/processes/conformance
ParameterInRequiredTypeDescription
fquerynostring (enum: json, html)Metadata response format.

Responses 200 Conformance declaration

GET /ogc/processes/openapi.json

Get OGC API Processes OpenAPI document

Parameters for GET /ogc/processes/openapi.json
ParameterInRequiredTypeDescription
fquerynostring (enum: json)OpenAPI document response format.

Responses 200 OpenAPI document · 404 OpenAPI document not found

GET /ogc/processes/processes

List available processes

No parameters.

Responses 200 Process list

GET /ogc/processes/processes/{processId}

Get process description

Parameters for GET /ogc/processes/processes/{processId}
ParameterInRequiredTypeDescription
processIdpathyesstring

Responses 200 Process description · 404 No such process

POST /ogc/processes/processes/{processId}/execution

Execute a process

Parameters for POST /ogc/processes/processes/{processId}/execution
ParameterInRequiredTypeDescription
processIdpathyesstring
PreferheadernostringOptional preference hint. Async execution is the default for this process; 'respond-async' is accepted and echoed via Preference-Applied when supplied.

Request body application/json (required) · Execute

Responses 201 Async job created · 400 Invalid request · 401 Authentication required · 403 Permission denied or approval required · 404 No such process · 501 Unsupported response mode in V1 · 503 Durable job storage unavailable

GET /ogc/processes/jobs

List jobs

Parameters for GET /ogc/processes/jobs
ParameterInRequiredTypeDescription
limitquerynointeger (min 1)

Responses 200 Job list · 400 Invalid request (e.g. limit <= 0) · 401 Authentication required · 403 Permission denied · 503 Durable job storage unavailable

GET /ogc/processes/jobs/{jobId}

Get job status

Parameters for GET /ogc/processes/jobs/{jobId}
ParameterInRequiredTypeDescription
jobIdpathyesstring

Responses 200 Job status · 401 Authentication required · 403 Permission denied · 404 No such job · 503 Durable job storage unavailable

DELETE /ogc/processes/jobs/{jobId}

Request dismissal of a job

Parameters for DELETE /ogc/processes/jobs/{jobId}
ParameterInRequiredTypeDescription
jobIdpathyesstring

Responses 200 Job dismissal confirmed · 401 Authentication required · 403 Permission denied · 404 No such job · 409 Dismiss could not be applied or confirmed · 503 Durable job storage unavailable

GET /ogc/processes/jobs/{jobId}/results

Get job results

Parameters for GET /ogc/processes/jobs/{jobId}/results
ParameterInRequiredTypeDescription
jobIdpathyesstring

Responses 200 Job succeeded. Document-mode results keyed by output identifier per OGC API Processes Part 1 §7.11.1. V1 declares no value-typed outputs on the canonical process, so the body is an empty object; populated entries land here once result storage ships. · 401 Authentication required · 403 Permission denied · 404 Job not found or not yet in a terminal state · 410 Job has been dismissed · 500 Job failed during execution · 503 Durable job storage unavailable

STAC API

STAC API surface for Honua geospatial discovery. Mounted at https://demo.honua.io/stac · document version 1.0.0 · raw OpenAPI document ↗

curl -sS "https://demo.honua.io/stac"

GET /stac

STAC root catalog

No parameters.

Responses 200 STAC Catalog

GET /stac/conformance

STAC conformance declaration

No parameters.

Responses 200 Conformance declaration

GET /stac/collections

STAC collections

No parameters.

Responses 200 STAC Collections response

GET /stac/collections/{collectionId}

STAC collection

Parameters for GET /stac/collections/{collectionId}
ParameterInRequiredTypeDescription
collectionIdpathyesstring

Responses 200 STAC Collection

GET /stac/collections/{collectionId}/items

STAC collection items

Parameters for GET /stac/collections/{collectionId}/items
ParameterInRequiredTypeDescription
collectionIdpathyesstring

Responses 200 STAC ItemCollection

GET /stac/collections/{collectionId}/items/{itemId}

STAC item

Parameters for GET /stac/collections/{collectionId}/items/{itemId}
ParameterInRequiredTypeDescription
collectionIdpathyesstring
itemIdpathyesstring

Responses 200 STAC Item

GET /stac/queryables

STAC catalog queryables

No parameters.

Responses 200 Queryables JSON Schema

GET /stac/collections/{collectionId}/queryables

STAC collection queryables

Parameters for GET /stac/collections/{collectionId}/queryables
ParameterInRequiredTypeDescription
collectionIdpathyesstring

Responses 200 Queryables JSON Schema

POST /stac/search

STAC item search

No parameters.

Responses 200 STAC ItemCollection

OGC API Styles

OGC API Styles adapter over Honua per-layer style storage (ADR-0048, Phase 1) · document version 1.0.0 · raw OpenAPI document ↗

The demo server's OGC API Styles document currently publishes no paths ("paths": {}). There is nothing to render for this surface yet; the document exists as a placeholder for the styles adapter. Style management endpoints are available under the Server Management API (Styles tag).

Server Management API (admin)

Curated OpenAPI snapshot of key Honua Server administrative endpoints for configuration, import scanning, connections, layers, styles, observability, realtime alert management, durable job viewing, package validation and preview planning, runtime licensing, deploy control, and native client-certificate trust management. For full runtime endpoint discovery, use /api/v1/admin/config and the Control Plane guide.

Base URL https://demo.honua.io/api/v1/admin · document version 1.0.0 · raw OpenAPI document ↗

Summarized on purpose: this document describes 395 operations across 319 paths in 50 tag groups. Every operation is listed below with its method, path, and summary — nothing is dropped — but parameter tables, request bodies, and per-operation response codes are not repeated here. For those, open the live console ↗ or the raw document. All admin endpoints require authentication (API key, bearer token, or basic auth); unauthenticated requests return 401.

curl -sS -H "X-API-Key: $HONUA_API_KEY" "https://demo.honua.io/api/v1/admin/capabilities"

Alerts

18 operations
Alerts admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/alerts/zonesList Alert Zones
POST/api/v1/admin/alerts/zonesCreate Alert Zone
GET/api/v1/admin/alerts/zones/{zoneId}Get Alert Zone
PUT/api/v1/admin/alerts/zones/{zoneId}Update Alert Zone
DELETE/api/v1/admin/alerts/zones/{zoneId}Delete Alert Zone
GET/api/v1/admin/alerts/rulesList Alert Rules
POST/api/v1/admin/alerts/rulesCreate Alert Rule
POST/api/v1/admin/alerts/rules/testTest Alert Rule
GET/api/v1/admin/alerts/rules/{ruleId}Get Alert Rule
PUT/api/v1/admin/alerts/rules/{ruleId}Update Alert Rule
DELETE/api/v1/admin/alerts/rules/{ruleId}Delete Alert Rule
PUT/api/v1/admin/alerts/rules/{ruleId}/enabledSet Alert Rule Enabled State
GET/api/v1/admin/alerts/rules/{ruleId}/healthGet Alert Rule Health
GET/api/v1/admin/alerts/channelsList Alert Channel States
POST/api/v1/admin/alerts/channels/{channel}/pausePause Alert Channel
POST/api/v1/admin/alerts/channels/{channel}/resumeResume Alert Channel
POST/api/v1/admin/alerts/dispatch/redriveRedrive Alert Dead-Letters
GET/api/v1/admin/alerts/rules/{ruleId}/eventsList Alert Rule Events

API Keys

5 operations
API Keys admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/api-keysList Admin API Keys
POST/api/v1/admin/api-keysCreate Admin API Key
POST/api/v1/admin/api-keys/{id}/rotateRotate Admin API Key
POST/api/v1/admin/api-keys/{id}/revokeRevoke Admin API Key
GET/api/v1/admin/api-keys/{id}/effective-permissionsGet Admin API Key Effective Permissions

Cache

2 operations
Cache admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/cache/statusGet cache health status
POST/api/v1/admin/cache/invalidateInvalidate cached responses by scope

Cloud Rasters

5 operations
Cloud Rasters admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/cloud-rastersList Cloud Rasters
POST/api/v1/admin/cloud-rastersRegister Cloud Raster
GET/api/v1/admin/cloud-rasters/{id}Get Cloud Raster
DELETE/api/v1/admin/cloud-rasters/{id}Unregister Cloud Raster
POST/api/v1/admin/cloud-rasters/{id}/refreshRefresh Cloud Raster Metadata

Compliance

4 operations
Compliance admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/compliance/dashboardGet Compliance Dashboard
GET/api/v1/admin/compliance/reportExport Compliance Report
POST/api/v1/admin/compliance/residency/evaluateEvaluate Residency Policy
POST/api/v1/admin/compliance/encryption/rotate-keyAdvance Compliance Key-Version Posture

Configuration

8 operations
Configuration admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/configGet Configuration Documentation
GET/api/v1/admin/openapi.jsonGet Admin OpenAPI Specification
GET/api/v1/admin/configuration/discoverDiscover Configuration
GET/api/v1/admin/configuration/metadataGet Configuration Metadata
GET/api/v1/admin/configuration/auto-documentationGet Configuration Auto-Documentation
GET/api/v1/admin/configuration/secrets/validateValidate Configuration Secrets
GET/api/v1/admin/configuration/auditGet Configuration Audit Info
GET/api/v1/admin/configuration/summaryGet Configuration Summary

Connections

10 operations
Connections admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/connectionsList Secure Connections
POST/api/v1/admin/connectionsCreate Secure Connection
GET/api/v1/admin/connections/{id}Get Secure Connection
PUT/api/v1/admin/connections/{id}Update Secure Connection
DELETE/api/v1/admin/connections/{id}Delete Secure Connection
GET/api/v1/admin/connections/{id}/tablesGet Connection Tables
POST/api/v1/admin/connections/testTest Draft Connection
POST/api/v1/admin/connections/{id}/testTest Saved Connection
POST/api/v1/admin/connections/encryption/validateValidate Encryption Service
POST/api/v1/admin/connections/encryption/rotate-keyRotate Encryption Key

Deploy

8 operations
Deploy admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/deploy/preflightGet Deploy Preflight
POST/api/v1/admin/deploy/planPlan Deploy Operation
GET/api/v1/admin/deploy/operationsList Deploy Operations
POST/api/v1/admin/deploy/operationsCreate Deploy Operation
GET/api/v1/admin/deploy/operations/{operationId}Get Deploy Operation
POST/api/v1/admin/deploy/operations/{operationId}/submitSubmit Deploy Operation
POST/api/v1/admin/deploy/operations/{operationId}/rollbackRollback Deploy Operation
POST/api/v1/admin/deploy/operations/{operationId}/promotePromote Deploy Operation

Embed

6 operations
Embed admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/embed/keysList Embed Keys
POST/api/v1/admin/embed/keysCreate Embed Key
GET/api/v1/admin/embed/keys/{id}Get Embed Key
POST/api/v1/admin/embed/keys/{id}/rotateRotate Embed Key
POST/api/v1/admin/embed/keys/{id}/revokeRevoke Embed Key
GET/api/v1/admin/embed/usageQuery Embed Usage

External Services

1 operation
External Services admin operations: method, path, and summary
MethodPathSummary
POST/api/v1/admin/external-services/discoverDiscover External Service

Feature Events

1 operation
Feature Events admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/feature-events/replayReplay feature-change events

Features

1 operation
Features admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/featuresGet Feature Overview

Federation

2 operations
Federation admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/federation/sourcesList Federated Sources
GET/api/v1/admin/federation/sources/{id}/planPlan Federated Query

Field Mask Policies

4 operations
Field Mask Policies admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/field-mask-policiesList Field-Mask Policies
POST/api/v1/admin/field-mask-policiesCreate Field-Mask Policy
GET/api/v1/admin/field-mask-policies/{id}Get Field-Mask Policy
DELETE/api/v1/admin/field-mask-policies/{id}Delete Field-Mask Policy

Field Workflows

7 operations
Field Workflows admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/field-workflows/submissionsList Field Submissions
GET/api/v1/admin/field-workflows/submissions/{submissionId}Get Field Submission
POST/api/v1/admin/field-workflows/submissions/{submissionId}/assignmentAssign Field Submission
POST/api/v1/admin/field-workflows/submissions/{submissionId}/decisionDecide Field Submission
POST/api/v1/admin/field-workflows/submissions/{submissionId}/commentsComment On Field Submission
GET/api/v1/admin/field-workflows/exportsList Field Exports
POST/api/v1/admin/field-workflows/exportsCreate Field Export

Forms

10 operations
Forms admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/forms/packagesList Form Packages
POST/api/v1/admin/forms/packagesCreate Form Package Draft
POST/api/v1/admin/forms/packages/generateGenerate Form Package
GET/api/v1/admin/forms/packages/{formId}Get Current Form Package
GET/api/v1/admin/forms/packages/{formId}/versionsList Form Package Versions
GET/api/v1/admin/forms/packages/{formId}/versions/{packageVersion}Get Form Package Version
PUT/api/v1/admin/forms/packages/{formId}/versions/{packageVersion}Update Form Package Draft
POST/api/v1/admin/forms/packages/{formId}/versions/{packageVersion}/validateValidate Form Package Version
POST/api/v1/admin/forms/packages/{formId}/versions/{packageVersion}/publishPublish Form Package Version
POST/api/v1/admin/forms/packages/{formId}/versions/{packageVersion}/reopenReopen Form Package Version

Geocoding

2 operations
Geocoding admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/geocoding/providersGet Geocoding Providers
POST/api/v1/admin/geocoding/reference-data/importImport Geocoder Reference Data

Geoprocessing

1 operation
Geoprocessing admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/geoprocessing/tools/usage-rankingGet geoprocessing tool usage ranking

Identity

2 operations
Identity admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/identity/providersGet Identity Providers
GET/api/v1/admin/identity/providers/{providerType}/testTest Identity Provider Connectivity

Import

41 operations
Import admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/import/formatsGet Supported Import Formats
POST/api/v1/admin/import/toolbox/translation/validateValidate a Translated Toolbox Manifest
POST/api/v1/admin/import/previewPreview a Geospatial File
POST/api/v1/admin/import/preview-urlPreview a Geospatial File from a URL
POST/api/v1/admin/import/upload-urlImport a Geospatial File from a URL
GET/api/v1/admin/import/limitsGet Import Limits
GET/api/v1/admin/import/jobsList Active Import Jobs
GET/api/v1/admin/import/jobs/{jobId}Get Import Job Status
POST/api/v1/admin/import/jobs/{jobId}/cancelCancel an Import Job
POST/api/v1/admin/import/uploadUpload and Import a Geospatial File
POST/api/v1/admin/import/scanScan Migration Source
GET/api/v1/admin/import/arcgis/migrationsList ArcGIS Migration Runs
GET/api/v1/admin/import/arcgis/migrations/{runId}/manifestGet ArcGIS Migration Manifest
POST/api/v1/admin/import/arcgis/migrations/{runId}/manifestRecord ArcGIS Migration Manifest
GET/api/v1/admin/import/arcgis/migrations/{runId}/parityGet ArcGIS Migration Parity
POST/api/v1/admin/import/arcgis/migrations/{runId}/parityRecord ArcGIS Migration Parity
POST/api/v1/admin/import/geoserver/discoverDiscover GeoServer Service
POST/api/v1/admin/import/geoserver/startStart GeoServer Import
GET/api/v1/admin/import/geoserver/jobsList GeoServer Import Jobs
GET/api/v1/admin/import/geoserver/jobs/{jobId}Get GeoServer Import Job
POST/api/v1/admin/import/geoserver/jobs/{jobId}/cancelCancel GeoServer Import Job
POST/api/v1/admin/import/geoservices/discoverDiscover GeoServices Service
POST/api/v1/admin/import/geoservices/startStart GeoServices Import
GET/api/v1/admin/import/geoservices/jobsList GeoServices Import Jobs
GET/api/v1/admin/import/geoservices/jobs/{jobId}Get GeoServices Import Job
POST/api/v1/admin/import/geoservices/jobs/{jobId}/cancelCancel GeoServices Import Job
POST/api/v1/admin/import/migrationsStart Migration Batch
GET/api/v1/admin/import/migrations/{batchId}Get Migration Batch
POST/api/v1/admin/import/ogc-api-features/collectionImport OGC API Features Collection
POST/api/v1/admin/import/ogc-tiles/exportExport OGC WMTS Tile Cache
POST/api/v1/admin/import/ogc-wcs/importImport Legacy WCS Coverages
POST/api/v1/admin/import/ogc-wfs/startStart OGC WFS Import
POST/api/v1/admin/import/ogc/coverages/importImport OGC Coverages
POST/api/v1/admin/import/rasterImport Raster File
GET/api/v1/admin/import/raster/formatsGet Raster Import Formats
PATCH/api/v1/admin/import/raster/{rasterId}Update Imported Raster
DELETE/api/v1/admin/import/raster/{rasterId}Delete Imported Raster
POST/api/v1/admin/import/tile-packageImport Tile Cache Package
GET/api/v1/admin/import/uploadsList Active Import Uploads
POST/api/v1/admin/import/uploads/{uploadId}/cancelCancel Import Upload
GET/api/v1/admin/import/uploads/{uploadId}/progressGet Import Upload Progress

Investigations

8 operations
Investigations admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/investigationsList Investigations
POST/api/v1/admin/investigationsCreate Investigation
GET/api/v1/admin/investigations/{investigationId}Get Investigation
PATCH/api/v1/admin/investigations/{investigationId}Update Investigation
POST/api/v1/admin/investigations/{investigationId}/linksLink Resource To Investigation
DELETE/api/v1/admin/investigations/{investigationId}/links/{linkId}Remove Investigation Link
POST/api/v1/admin/investigations/{investigationId}/pinsPin Event To Investigation
DELETE/api/v1/admin/investigations/{investigationId}/pins/{pinId}Remove Investigation Pin

Jobs

8 operations
Jobs admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/jobsList Console Jobs
GET/api/v1/admin/jobs/{jobId}Get Console Job Detail
GET/api/v1/admin/jobs/{jobId}/logsGet Console Job Logs
GET/api/v1/admin/jobs/{jobId}/artifactsGet Console Job Artifacts
GET/api/v1/admin/jobs/{jobId}/actionsGet Console Job Actions
POST/api/v1/admin/jobs/{jobId}/cancelCancel Console Job
POST/api/v1/admin/jobs/{jobId}/retryRetry Console Job
GET/api/v1/admin/jobs/{jobId}/stepsGet Console Job Steps

Layers

7 operations
Layers admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/connections/{id}/layersList Published Layers
POST/api/v1/admin/connections/{id}/layersPublish Layer
PUT/api/v1/admin/connections/{id}/layers/{layerId}/enabledSet Layer Enabled
PUT/api/v1/admin/connections/{id}/layers/enabledSet Service Layers Enabled
POST/api/v1/admin/connections/{id}/tables/validateValidate Table For Layer Publishing
POST/api/v1/admin/connections/{id}/layers/extents/refreshRefresh Layer Extents
POST/api/v1/admin/connections/{id}/layers/{layerId}/features/refreshRefresh Layer Feature Snapshot

License

8 operations
License admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/licenseGet License Status
POST/api/v1/admin/licenseUpload License
GET/api/v1/admin/license/entitlementsGet License Entitlements
GET/api/v1/admin/license/statusGet Platform License Status
GET/api/v1/admin/license/featuresGet License Feature Entitlements
POST/api/v1/admin/license/uploadUpload License File
GET/api/v1/admin/license/capacityGet License Capacity State
POST/api/v1/admin/license/capacity/surgeSet License Surge Mode

Metadata

26 operations
Metadata admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/capabilitiesGet Admin Capabilities
GET/api/v1/admin/versionGet Admin Version Info
GET/api/v1/admin/metadata/environments/{environment}/inventoryGet Metadata Semantic Inventory
POST/api/v1/admin/metadata/environment-bindings/queryQuery Metadata Environment Bindings
GET/api/v1/admin/metadata/release-packagesList Metadata Release Packages
POST/api/v1/admin/metadata/release-packagesCreate Metadata Release Package
GET/api/v1/admin/metadata/release-packages/{packageId}Get Metadata Release Package
GET/api/v1/admin/metadata/release-packages/{packageId}/gitops-manifestGet Metadata Release GitOps Manifest
GET/api/v1/admin/metadata/releases/{packageId}/operationGet Metadata Release Operation
POST/api/v1/admin/metadata/prevalidatePrevalidate Metadata Release Package Compatibility
POST/api/v1/admin/metadata/coordinated-releases/operationsCreate Coordinated Release Operation
POST/api/v1/admin/metadata/coordinated-releases/operations/{operationId}/approve/{gate}Approve Coordinated Release Gate
POST/api/v1/admin/metadata/coordinated-releases/operations/{operationId}/rollbackRoll Back Coordinated Release
GET/api/v1/admin/metadata/coordinated-releases/{packageId}/operationGet Coordinated Release Operation
POST/api/v1/admin/metadata/releases/operationsCreate Metadata Release Operation
GET/api/v1/admin/metadata/layers/{layerId}/popup-infoGet Layer Popup Info
PUT/api/v1/admin/metadata/layers/{layerId}/popup-infoSet Layer Popup Info
GET/api/v1/admin/metadata/layers/{layerId}/drawing-infoGet Layer Drawing Info
PUT/api/v1/admin/metadata/layers/{layerId}/drawing-infoSet Layer Drawing Info
GET/api/v1/admin/metadata/layers/{layerId}/relationshipsGet Layer Relationships
PUT/api/v1/admin/metadata/layers/{layerId}/relationshipsSet Layer Relationships
GET/api/v1/admin/metadata/layers/{layerId}/fieldsGet Layer Field Configuration
PUT/api/v1/admin/metadata/layers/{layerId}/fieldsUpdate Layer Field Configuration
GET/api/v1/admin/metadata/layers/{layerId}/filterGet Layer Permanent Filter
PUT/api/v1/admin/metadata/layers/{layerId}/filterUpdate Layer Permanent Filter
GET/api/v1/admin/metadata/layers/{layerId}/validationValidate Layer Metadata

Migration

11 operations
Migration admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/migration/performance-evidence/latestGet Latest Migration Performance Evidence
GET/api/v1/admin/migration/performance-evidence/historyList Migration Performance Evidence History
GET/api/v1/admin/migration/performance-evidence/{evidenceId}Get Migration Performance Evidence
GET/api/v1/admin/migration/runsList Migration Runs
POST/api/v1/admin/migration/runsRecord Migration Run Started
GET/api/v1/admin/migration/runs/{runId}Get Migration Run
POST/api/v1/admin/migration/runs/{runId}/completeRecord Migration Run Completed
POST/api/v1/admin/migration/runs/{runId}/cancelCancel Migration Run
GET/api/v1/admin/migration/runs/{runId}/evidence-packDownload Migration Run Evidence Pack
GET/api/v1/admin/migration/runs/{runId}/scorecardDownload Migration Run Reconciliation Scorecard
POST/api/v1/admin/migration/runs/{runId}/scorecardRecord Migration Run Reconciliation Scorecard

Multidimensional Coverages

6 operations
Multidimensional Coverages admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/multidim-coveragesList Multidimensional Coverages
POST/api/v1/admin/multidim-coveragesRegister Multidimensional Coverage
GET/api/v1/admin/multidim-coverages/jobs/{jobId}Get Multidimensional Coverage Scan Job
GET/api/v1/admin/multidim-coverages/{id}Get Multidimensional Coverage
DELETE/api/v1/admin/multidim-coverages/{id}Unregister Multidimensional Coverage
POST/api/v1/admin/multidim-coverages/{id}/refreshRefresh Multidimensional Coverage Metadata

Network Datasets

13 operations
Network Datasets admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/network-datasetsList Network Datasets
POST/api/v1/admin/network-datasetsRegister Network Dataset
GET/api/v1/admin/network-datasets/{id}Get Network Dataset
PUT/api/v1/admin/network-datasets/{id}Update Network Dataset
DELETE/api/v1/admin/network-datasets/{id}Delete Network Dataset
GET/api/v1/admin/network-datasets/{id}/generationsList Topology Generations
POST/api/v1/admin/network-datasets/{id}/generationsAllocate Draft Topology Generation
POST/api/v1/admin/network-datasets/{id}/generations/{generation}/editsApply Topology Edit Batch
POST/api/v1/admin/network-datasets/{id}/generations/{generation}/rebuildSubmit Topology Rebuild
GET/api/v1/admin/network-datasets/{id}/generations/{generation}/rebuild/{attempt}Get Topology Rebuild Attempt
POST/api/v1/admin/network-datasets/{id}/promotePromote Topology Generation
POST/api/v1/admin/network-datasets/{id}/rollbackRoll Back Topology Generation
GET/api/v1/admin/network-datasets/{id}/promotionsList Topology Promotions

OAuth Clients

4 operations
OAuth Clients admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/oauth-clientsList OAuth Clients
POST/api/v1/admin/oauth-clientsRegister OAuth Client
GET/api/v1/admin/oauth-clients/{id}Get OAuth Client
DELETE/api/v1/admin/oauth-clients/{id}Delete OAuth Client

OAuth Scopes

3 operations
OAuth Scopes admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/oauth-scopesList OAuth Scopes
PUT/api/v1/admin/oauth-scopesDefine OAuth Scope
DELETE/api/v1/admin/oauth-scopes/{scope}Delete OAuth Scope

Observability

22 operations
Observability admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/observability/errorsGet Recent Errors
GET/api/v1/admin/observability/telemetryGet Telemetry Status
GET/api/v1/admin/observability/migrationsGet Migration Status
GET/api/v1/admin/observability/alertsList Observability Alerts
GET/api/v1/admin/observability/alerts/{eventId}Get Observability Alert
POST/api/v1/admin/observability/alerts/{eventId}/acknowledgeAcknowledge Observability Alert
POST/api/v1/admin/observability/alerts/{eventId}/resolveResolve Observability Alert
POST/api/v1/admin/observability/alerts/{eventId}/suppressSuppress Observability Alert
GET/api/v1/admin/observability/auditList Audit Log Entries
GET/api/v1/admin/observability/audit/exportExport Audit Trail (SIEM)
GET/api/v1/admin/observability/audit/verifyVerify Audit Trail Integrity
GET/api/v1/admin/observability/autonomy/policiesList Ops Autonomy Policies
GET/api/v1/admin/observability/autonomy/policies/{rule}Get Ops Autonomy Policy
PUT/api/v1/admin/observability/autonomy/policies/{rule}Set Ops Autonomy Policy
GET/api/v1/admin/observability/autonomy/settingsGet Ops Autonomy Settings
PUT/api/v1/admin/observability/autonomy/settingsSet Ops Autonomy Settings
GET/api/v1/admin/observability/eventsList Operate Events
GET/api/v1/admin/observability/findingsGet Ops Findings
POST/api/v1/admin/observability/findings/{findingId}/proposePropose Ops Finding Action
GET/api/v1/admin/observability/logsList Recent Server Logs
GET/api/v1/admin/observability/ops-healthGet Ops Health Snapshot
GET/api/v1/admin/observability/ops-health/historyGet Ops Health History

OIDC

6 operations
OIDC admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/oidc/providersList OIDC Providers
POST/api/v1/admin/oidc/providersCreate OIDC Provider
GET/api/v1/admin/oidc/providers/{id}Get OIDC Provider
PUT/api/v1/admin/oidc/providers/{id}Update OIDC Provider
DELETE/api/v1/admin/oidc/providers/{id}Delete OIDC Provider
POST/api/v1/admin/oidc/providers/{id}/testTest OIDC Provider Connection

Operations

13 operations
Operations admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/operations/cache/healthGet Cache Health
GET/api/v1/admin/operations/cache/statisticsGet Cache Statistics
GET/api/v1/admin/operations/cache/redisGet Redis Connection Metrics
POST/api/v1/admin/operations/cache/invalidateInvalidate Cache
GET/api/v1/admin/operations/geocoding/providersGet Geocoding Provider Status
GET/api/v1/admin/operations/geocoding/configurationGet Geocoding Configuration
GET/api/v1/admin/operations/streaming/subscribersList Streaming Subscribers
GET/api/v1/admin/operations/streaming/alertsStream Alert Notifications
DELETE/api/v1/admin/operations/streaming/subscribers/{subscriberId}Disconnect Streaming Subscriber
GET/api/v1/admin/operations/activeList Active Operations
GET/api/v1/admin/operations/type/{operationType}Get Operations By Type
GET/api/v1/admin/operations/{operationId}Get Operation Status
POST/api/v1/admin/operations/{operationId}/cancelCancel Operation

Packages

2 operations
Packages admin operations: method, path, and summary
MethodPathSummary
POST/api/v1/admin/packages/validateValidate Package
POST/api/v1/admin/packages/previewPreview Package

Performance

12 operations
Performance admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/performance/database/query-cache/statisticsGet prepared statement cache statistics
GET/api/v1/admin/performance/enhanced/database/query-performanceGet database query performance statistics
GET/api/v1/admin/performance/enhanced/database/slow-queriesGet recent slow queries
GET/api/v1/admin/performance/enhanced/resources/trackingGet resource tracking statistics
GET/api/v1/admin/performance/enhanced/resources/potential-leaksGet potential resource leaks
POST/api/v1/admin/performance/enhanced/resources/scan-leaksScan for resource leaks
GET/api/v1/admin/performance/enhanced/exceptions/statisticsGet exception statistics
GET/api/v1/admin/performance/enhanced/exceptions/recentGet recent exceptions
GET/api/v1/admin/performance/enhanced/cache/statisticsGet query-result cache statistics
GET/api/v1/admin/performance/enhanced/cache/effectivenessGet cache effectiveness metrics
DELETE/api/v1/admin/performance/enhanced/cache/invalidateInvalidate query-result cache entries
GET/api/v1/admin/performance/enhanced/summaryGet overall performance summary

Platform Release

1 operation
Platform Release admin operations: method, path, and summary
MethodPathSummary
POST/api/v1/admin/platform-release/convergeConverge Platform Release

Proposals

4 operations
Proposals admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/proposalsList Operation Proposals
GET/api/v1/admin/proposals/{id}Get Operation Proposal
POST/api/v1/admin/proposals/{id}/approveApprove Operation Proposal
POST/api/v1/admin/proposals/{id}/rejectReject Operation Proposal

Rate Limits

6 operations
Rate Limits admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/rate-limitsList Rate Limit Policies
POST/api/v1/admin/rate-limitsCreate Rate Limit Policy
GET/api/v1/admin/rate-limits/statusGet Rate Limit Status
GET/api/v1/admin/rate-limits/{id}Get Rate Limit Policy
PUT/api/v1/admin/rate-limits/{id}Update Rate Limit Policy
DELETE/api/v1/admin/rate-limits/{id}Delete Rate Limit Policy

RLS Policies

4 operations
RLS Policies admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/rls-policiesList RLS Policies
POST/api/v1/admin/rls-policiesCreate RLS Policy
GET/api/v1/admin/rls-policies/{id}Get RLS Policy
DELETE/api/v1/admin/rls-policies/{id}Delete RLS Policy

Roles

7 operations
Roles admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/rolesList Roles
POST/api/v1/admin/rolesCreate Role
GET/api/v1/admin/roles/{id}Get Role
PUT/api/v1/admin/roles/{id}Update Role
DELETE/api/v1/admin/roles/{id}Delete Role
GET/api/v1/admin/roles/{id}/permissionsGet Role Permissions
PUT/api/v1/admin/roles/{id}/permissionsSet Role Permissions

Scenes

9 operations
Scenes admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/scenesList Scene Datasets
POST/api/v1/admin/scenesRegister Scene Dataset
POST/api/v1/admin/scenes/generateGenerate Scene From Feature Layer
POST/api/v1/admin/scenes/ingest/citygmlIngest CityGML Scene
POST/api/v1/admin/scenes/ingest/pointcloudIngest Point Cloud Scene
GET/api/v1/admin/scenes/{id}Get Scene Dataset
PUT/api/v1/admin/scenes/{id}Update Scene Dataset
DELETE/api/v1/admin/scenes/{id}Deactivate Scene Dataset
GET/api/v1/admin/scenes/{id}/resolveResolve Scene Dataset

Security

20 operations
Security admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/auth/configGet Admin Auth Configuration
GET/api/v1/admin/security/client-certificates/profilesList Client Certificate Trust Profiles
POST/api/v1/admin/security/client-certificates/profilesCreate Client Certificate Trust Profile
GET/api/v1/admin/security/client-certificates/profiles/{profileId}Get Client Certificate Trust Profile
PUT/api/v1/admin/security/client-certificates/profiles/{profileId}Update Client Certificate Trust Profile
DELETE/api/v1/admin/security/client-certificates/profiles/{profileId}Disable Client Certificate Trust Profile
GET/api/v1/admin/security/client-certificates/profiles/{profileId}/mappingsList Client Certificate Principal Mappings
POST/api/v1/admin/security/client-certificates/profiles/{profileId}/mappingsCreate Client Certificate Principal Mapping
PUT/api/v1/admin/security/client-certificates/profiles/{profileId}/mappings/{mappingId}Update Client Certificate Principal Mapping
DELETE/api/v1/admin/security/client-certificates/profiles/{profileId}/mappings/{mappingId}Disable Client Certificate Principal Mapping
GET/api/v1/admin/security/client-certificates/profiles/{profileId}/revocationsList Client Certificate Revocations
POST/api/v1/admin/security/client-certificates/profiles/{profileId}/revocationsAdd Client Certificate Revocation
DELETE/api/v1/admin/security/client-certificates/profiles/{profileId}/revocations/{revocationId}Remove Client Certificate Revocation
POST/api/v1/admin/security/client-certificates/validateValidate Client Certificate
GET/api/v1/admin/auth/sessionGet Admin Auth Session
POST/api/v1/admin/auth/bearerIssue Console Operator Bearer
POST/api/v1/admin/auth/logoutLogout Admin Auth Session
POST/api/v1/admin/auth/providers/{providerKey}/authorize-urlCreate Admin Auth Authorize Url
POST/api/v1/admin/auth/providers/{providerKey}/tokenRequest Admin Auth Token
GET/api/v1/admin/auth/providers/{providerKey}/logout-urlGet Admin Auth Logout Url

Services

13 operations
Services admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/servicesList Services
GET/api/v1/admin/services/{serviceName}/settingsGet Service Settings
PUT/api/v1/admin/services/{serviceName}/protocolsUpdate Service Protocols
PUT/api/v1/admin/services/{serviceName}/mapserverUpdate MapServer Settings
PUT/api/v1/admin/services/{serviceName}/access-policyUpdate Service Access Policy
PUT/api/v1/admin/services/{serviceName}/timeinfoUpdate Service Time Info
PUT/api/v1/admin/services/{serviceName}/layers/{layerId}/metadataUpdate Layer Metadata
GET/api/v1/admin/services/{serviceId}/replicasList Service Replicas
GET/api/v1/admin/services/{serviceId}/replicas/{replicaId}Get Service Replica
GET/api/v1/admin/services/{serviceId}/replicas/{replicaId}/conflictsList Replica Conflicts
GET/api/v1/admin/services/{serviceId}/replicas/{replicaId}/conflicts/{conflictId}Get Replica Conflict
POST/api/v1/admin/services/{serviceId}/replicas/{replicaId}/conflicts/{conflictId}/resolveResolve Replica Conflict
GET/api/v1/admin/services/{serviceName}/layers/{layerId}/exportExport Layer Data

Share

14 operations
Share admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/share/exportsList Share Export Definitions
POST/api/v1/admin/share/exportsCreate Share Export Definition
GET/api/v1/admin/share/exports/{exportId}Get Share Export Definition
PUT/api/v1/admin/share/exports/{exportId}Replace Share Export Definition
DELETE/api/v1/admin/share/exports/{exportId}Delete Share Export Definition
POST/api/v1/admin/share/exports/{exportId}/pausePause Share Export Definition
POST/api/v1/admin/share/exports/{exportId}/resumeResume Share Export Definition
POST/api/v1/admin/share/exports/{exportId}/triggerTrigger Share Export Run
GET/api/v1/admin/share/exports/{exportId}/runsList Share Export Runs
GET/api/v1/admin/share/exports/{exportId}/runs/{runId}Get Share Export Run
GET/api/v1/admin/share/trafficGet Aggregate Share Traffic Summary
GET/api/v1/admin/share/traffic/seriesGet Aggregate Share Traffic Series
GET/api/v1/admin/services/{serviceName}/layers/{layerId}/share/trafficGet Layer Share Traffic Summary
GET/api/v1/admin/services/{serviceName}/layers/{layerId}/share/traffic/seriesGet Layer Share Traffic Series

Streaming

2 operations
Streaming admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/streaming/features/sessionsList feature stream sessions
DELETE/api/v1/admin/streaming/features/sessions/{sessionId}Disconnect a feature stream session

Styles

5 operations
Styles admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/metadata/layers/{layerId}/styleGet Layer Style
PUT/api/v1/admin/metadata/layers/{layerId}/styleUpdate Layer Style
POST/api/v1/admin/metadata/layers/{layerId}/style/import-sldImport SLD Layer Style
GET/api/v1/admin/metadata/layers/{layerId}/style/export-sldExport Layer Style as SLD
POST/api/v1/admin/metadata/layers/{layerId}/suggest-styleSuggest Layer Style

Tenants

7 operations
Tenants admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/tenantsList Tenants
POST/api/v1/admin/tenantsCreate Tenant
GET/api/v1/admin/tenants/usageExport Tenant Billing Usage
GET/api/v1/admin/tenants/{tenantId}Get Tenant
DELETE/api/v1/admin/tenants/{tenantId}Delete Tenant
POST/api/v1/admin/tenants/{tenantId}/suspendSuspend Tenant
POST/api/v1/admin/tenants/{tenantId}/resumeResume Tenant

Tile Operations

6 operations
Tile Operations admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/tile-operations/jobsList Tile Operation Jobs
POST/api/v1/admin/tile-operations/jobsStart Tile Operation Job
GET/api/v1/admin/tile-operations/jobs/{jobId}Get Tile Operation Job Status
POST/api/v1/admin/tile-operations/jobs/{jobId}/cancelCancel Tile Operation Job
POST/api/v1/admin/tile-operations/jobs/{jobId}/retryRetry Tile Operation Job
POST/api/v1/admin/tile-operations/evictEvict Tile Cache

Users

5 operations
Users admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/usersList Users
GET/api/v1/admin/users/{id}Get User
DELETE/api/v1/admin/users/{id}Deprovision User
PUT/api/v1/admin/users/{id}/rolesUpdate User Roles
GET/api/v1/admin/users/{id}/effective-permissionsGet User Effective Permissions

Zarr Stores

5 operations
Zarr Stores admin operations: method, path, and summary
MethodPathSummary
GET/api/v1/admin/zarr-storesList Zarr Stores
POST/api/v1/admin/zarr-storesRegister Zarr Store
GET/api/v1/admin/zarr-stores/{id}Get Zarr Store
DELETE/api/v1/admin/zarr-stores/{id}Unregister Zarr Store
POST/api/v1/admin/zarr-stores/{id}/refreshRefresh Zarr Store Metadata

Not covered by a published OpenAPI document

The demo server's console publishes OpenAPI documents for the surfaces above only. The GeoServices REST surface (FeatureServer, MapServer, ImageServer, VectorTileServer, GeocodeServer, and the Geometry Service) is not described by a published OpenAPI document, so it does not appear on this page — its operation-level coverage is documented in the Esri → Honua compatibility matrix with request-level evidence in the claims matrix. The console also lists an aggregate “All protocols” document (/docs/protocols.openapi.json) which returned 405 Method Not Allowed when fetched on 2026-08-10; this page therefore renders the per-protocol documents directly.

Guides and narrative documentation live in the full documentation ↗; machine-readable SDK docs ship at /llms.txt and /llms-full.txt. For client and SDK coverage, see client and SDK compatibility.

Snapshot fetched 2026-08-10 (UTC) from the public demo server. Regenerate by re-fetching the raw documents linked above.