All paths are relative to /api/v1 on your neoserver instance.
Start with the management API guide for
practical examples, or use /api/v1/api.html on your running
server to send requests.
Download the OpenAPI specification
Version 0.1.2 120 operations 99 schemas OpenAPI 3.0.3
Audit
Authentication
- POST
/auth/loginCreate a browser session - POST
/auth/logoutRevoke the current browser session - GET
/auth/meGet current identity and console capabilities - POST
/auth/refreshRotate the current browser session - GET
/auth/sessionsList browser sessions - DELETE
/auth/sessions/{session}Revoke a browser session - GET
/console/configGet browser console configuration
Cache
Catalog Lifecycle
- GET
/catalog/integrityAudit catalog ownership integrity - POST
/catalog/integrity/repairRepair orphaned state from older releases - GET
/deletionsList visible deletion operations - GET
/deletions/{operation}Get deletion operation - POST
/deletions/{operation}/retryRetry deletion operation - GET
/workspaces/{workspace}/deletion-planInspect workspace deletion dependencies - GET
/workspaces/{workspace}/services/{service}/deletion-planInspect service deletion dependencies
Claim Mappings
- GET
/claim-mappingsList global claim mappings - POST
/claim-mappingsCreate global claim mapping - DELETE
/claim-mappings/{mappingId}Delete global claim mapping - GET
/workspaces/{workspace}/claim-mappingsList claim mappings - POST
/workspaces/{workspace}/claim-mappingsCreate claim mapping - GET
/workspaces/{workspace}/claim-mappings/{mappingId}Get claim mapping - DELETE
/workspaces/{workspace}/claim-mappings/{mappingId}Delete claim mapping
Roles
- GET
/rolesList roles - POST
/rolesCreate role - DELETE
/roles/{roleId}Delete role - GET
/roles/{roleId}/deletion-planInspect role deletion dependencies - GET
/roles/{roleId}/policiesList role policies - POST
/roles/{roleId}/policiesGrant a service or operation - DELETE
/roles/{roleId}/policiesRemove a service or operation grant - GET
/workspaces/{workspace}/rolesList roles assignable in a workspace
Tile Matrix Sets
- GET
/tile-matrix-setsList supported tile matrix sets - GET
/tile-matrix-sets/{tileMatrixSet}Get custom tile matrix set record - PUT
/tile-matrix-sets/{tileMatrixSet}Create or replace custom tile matrix set - DELETE
/tile-matrix-sets/{tileMatrixSet}Delete custom tile matrix set - GET
/workspaces/{workspace}/tile-matrix-setsList enabled workspace tile matrix sets
Workspaces
API Keys
Imports
- GET
/workspaces/{workspace}/importsList durable imports - POST
/workspaces/{workspace}/importsCreate URI or multipart import - GET
/workspaces/{workspace}/imports/{import}Get import - DELETE
/workspaces/{workspace}/imports/{import}Cancel import - GET
/workspaces/{workspace}/imports/{import}/historyList import transition history - PUT
/workspaces/{workspace}/imports/{import}/planValidate and set import plan - GET
/workspaces/{workspace}/imports/{import}/previewPreview planned import features - POST
/workspaces/{workspace}/imports/{import}/publishpublishImport - POST
/workspaces/{workspace}/imports/{import}/retryretryImport - POST
/workspaces/{workspace}/imports/{import}/rollbackrollbackImport
Layer Groups
- GET
/workspaces/{workspace}/layer-groupsList layer groups - POST
/workspaces/{workspace}/layer-groupsCreate layer group - GET
/workspaces/{workspace}/layer-groups/{group}Get layer group - PUT
/workspaces/{workspace}/layer-groups/{group}Update layer group - DELETE
/workspaces/{workspace}/layer-groups/{group}Delete layer group
Services
- GET
/workspaces/{workspace}/servicesList services - POST
/workspaces/{workspace}/servicesCreate service - POST
/workspaces/{workspace}/services/test-connectionTest a service connection before saving - GET
/workspaces/{workspace}/services/{service}Get service - PUT
/workspaces/{workspace}/services/{service}Update service - DELETE
/workspaces/{workspace}/services/{service}Delete service - POST
/workspaces/{workspace}/services/{service}/discoverDiscover layers - POST
/workspaces/{workspace}/services/{service}/test-connectionTest an existing service connection - POST
/workspaces/{workspace}/services/{service}/validate-sqlValidate SQL view
Coverages
- GET
/workspaces/{workspace}/services/{service}/coveragesList coverages - POST
/workspaces/{workspace}/services/{service}/coveragesPublish coverage - GET
/workspaces/{workspace}/services/{service}/coverages/{coverage}Get coverage - PUT
/workspaces/{workspace}/services/{service}/coverages/{coverage}Update coverage - DELETE
/workspaces/{workspace}/services/{service}/coverages/{coverage}Delete coverage - POST
/workspaces/{workspace}/services/{service}/discover-coveragesDiscover raster coverages
Layers
- GET
/workspaces/{workspace}/services/{service}/layersList layers - POST
/workspaces/{workspace}/services/{service}/layersCreate layer - GET
/workspaces/{workspace}/services/{service}/layers/{layer}Get layer - PUT
/workspaces/{workspace}/services/{service}/layers/{layer}Update layer - DELETE
/workspaces/{workspace}/services/{service}/layers/{layer}Delete layer
Mosaic Catalog
- GET
/workspaces/{workspace}/services/{service}/mosaic/granulesList active mosaic granules - GET
/workspaces/{workspace}/services/{service}/mosaic/granules/{granule}Get mosaic granule - DELETE
/workspaces/{workspace}/services/{service}/mosaic/granules/{granule}Remove granule through a new atomic generation - GET
/workspaces/{workspace}/services/{service}/mosaic/harvest-jobsList mosaic harvest jobs - POST
/workspaces/{workspace}/services/{service}/mosaic/harvest-jobsCreate atomic mosaic harvest job - GET
/workspaces/{workspace}/services/{service}/mosaic/harvest-jobs/{job}Get mosaic harvest job - DELETE
/workspaces/{workspace}/services/{service}/mosaic/harvest-jobs/{job}Cancel mosaic harvest job
Settings
- GET
/workspaces/{workspace}/settings/ogc-tilesGet OGC API Tiles settings - PUT
/workspaces/{workspace}/settings/ogc-tilesUpdate OGC API Tiles settings - GET
/workspaces/{workspace}/settings/ogcapiGet OGC API settings - PUT
/workspaces/{workspace}/settings/ogcapiUpdate OGC API settings - GET
/workspaces/{workspace}/settings/wcsGet WCS settings - PUT
/workspaces/{workspace}/settings/wcsUpdate WCS settings - GET
/workspaces/{workspace}/settings/wfsGet WFS settings - PUT
/workspaces/{workspace}/settings/wfsUpdate WFS settings - GET
/workspaces/{workspace}/settings/wmsGet WMS settings - PUT
/workspaces/{workspace}/settings/wmsUpdate WMS settings - GET
/workspaces/{workspace}/settings/wmtsGet WMTS settings - PUT
/workspaces/{workspace}/settings/wmtsUpdate WMTS settings
Styles
- GET
/workspaces/{workspace}/style-assetsList style assets - GET
/workspaces/{workspace}/style-assets/{asset}Download style asset - PUT
/workspaces/{workspace}/style-assets/{asset}Create or replace style asset - DELETE
/workspaces/{workspace}/style-assets/{asset}Delete style asset - GET
/workspaces/{workspace}/stylesList styles - POST
/workspaces/{workspace}/stylesCreate style - GET
/workspaces/{workspace}/styles/{style}Get style - PUT
/workspaces/{workspace}/styles/{style}Update style - DELETE
/workspaces/{workspace}/styles/{style}Delete style
Tile Cache
- GET
/workspaces/{workspace}/tile-cache/jobsList tile cache jobs - POST
/workspaces/{workspace}/tile-cache/jobsCreate seed, reseed, or truncate job - GET
/workspaces/{workspace}/tile-cache/jobs/{job}Get tile cache job - DELETE
/workspaces/{workspace}/tile-cache/jobs/{job}Cancel tile cache job - GET
/workspaces/{workspace}/tile-cache/jobs/{job}/progressGet per-zoom tile cache job progress - GET
/workspaces/{workspace}/tile-cache/statsGet persistent tile cache usage
Schemas
- APIKey
- APIKeyWithSecret
- AuditEvent
- AuditList
- AuthConsoleConfig
- AuthMe
- AuthSession
- AuthWorkspace
- BrowserSession
- BrowserSessionList
- CacheMetrics
- CacheStats
- ClaimMapping
- ConnectionInfo
- ConnectionTest
- ConsoleConfig
- Coverage
- CoverageCreate
- CoverageDiscoveryList
- CoverageInfo
- CoverageList
- CoverageRangeField
- CoverageUpdate
- CreateImportURI
- DeletionAuxiliary
- DeletionConflict
- DeletionList
- DeletionOperation
- DeletionPlan
- DeletionRef
- Dimension
- DiscoveredCoverage
- DiscoveredLayer
- Error
- GeoJSONFeature
- ImportDiscoveredLayer
- ImportDiscovery
- ImportEvent
- ImportFieldMapping
- ImportHistory
- ImportJob
- ImportLayerPlan
- ImportList
- ImportPlan
- ImportPreview
- ImportProperty
- IntegrityIssue
- IntegrityReport
- Layer
- LayerGroup
- LayerGroupMember
- LoginRequest
- MosaicGranule
- MosaicHarvestGranule
- MosaicHarvestJob
- MosaicHarvestRequest
- OGCAPISettings
- OGCTilesInnerSettings
- OGCTilesMapSettings
- OGCTilesSettings
- OGCTilesVectorSettings
- OIDCConsoleConfig
- Role
- RolePolicy
- RolePolicyList
- SQLView
- SQLViewColumn
- SQLViewDiscovery
- SQLViewProperty
- Service
- ServiceCacheSettings
- ServiceConnectionInput
- SpatialExtent
- Style
- StyleAsset
- StyleWithBody
- TileCacheBounds
- TileCacheJob
- TileCacheJobRequest
- TileCacheStats
- TileCacheUsage
- TileJobProgress
- TileMatrix
- TileMatrixBoundingBox
- TileMatrixSet
- TileMatrixSetDefinition
- TileMatrixSetDefinitions
- TileMatrixSetList
- TileMatrixSetRecord
- TileMatrixSetSummary
- TileZoomProgress
- ValidateSQLResponse
- WCSSettings
- WFSSettings
- WMSSettings
- WMTSSettings
- Workspace
- WorkspaceCounts
- WorkspaceSummary