Skip to content

OSDU APIs

OSDU provides many service APIs. The following are available on the Equinor ADME instance.

Replace {base} with your environment base URL (see ADME Technical Reference).

Core Services

1. Entitlements

Access control and permissions management.

Path /api/entitlements/v2/*
Health {base}/api/entitlements/v2/actuator/health
Swagger {base}/api/entitlements/v2/swagger-ui.html
Docs OSDU Entitlements
2. Legal

Legal tag management for compliance and data classification.

Path /api/legal/v1/*
Health {base}/api/legal/v1/actuator/health
Swagger {base}/api/legal/v1/swagger-ui.html
Docs OSDU Legal
3. Partition

Data partition management.

Path /api/partition/v1/*
Health {base}/api/partition/v1/actuator/health
Swagger {base}/api/partition/v1/swagger-ui.html
4. Schema

Schema management and discovery.

Path /api/schema-service/v1/*
Health {base}/api/schema-service/v1/
Swagger {base}/api/schema-service/v1/swagger-ui.html
Docs OSDU Schema
5. Storage

Record storage — create, read, update, and delete records.

Path /api/storage/v2/*
Health {base}/api/storage/v2/health
Swagger {base}/api/storage/v2/swagger-ui.html
Docs OSDU Storage
6. Search

Full-text and structured search across all records.

Path /api/search/v2/*
Health {base}/api/search/v2/actuator/health
Swagger {base}/api/search/v2/swagger-ui.html
Docs OSDU Search
7. Indexer

Search indexing service.

Path /api/indexer/v2/*
Health {base}/api/indexer/v2/actuator/health
Swagger {base}/api/indexer/v2/swagger-ui.html
Docs OSDU Indexer

Data Services

8. Dataset

Dataset management.

Path /api/dataset/v1/*
Docs OSDU Dataset
9. File

File upload and download.

Path /api/file/v2/*
Health {base}/api/file/v2/
Swagger {base}/api/file/v2/swagger-ui.html
Docs OSDU File
10. Workflow

Workflow orchestration.

Path /api/workflow/v1/*
Health {base}/api/workflow/v1/
Swagger {base}/api/workflow/v1/swagger-ui.html
Docs OSDU Workflow
11. Notification

Event notifications.

Path /api/notification/v1/*
Health {base}/api/notification/v1/actuator/health
Swagger {base}/api/notification/v1/swagger-ui.html
Docs OSDU Notification
12. Register

Service registration.

Path /api/register/v1/*
Health {base}/api/register/v1/actuator/health
Swagger {base}/api/register/v1/swagger-ui.html
Docs OSDU Register

Reference Services

13. CRS Catalog

Coordinate reference system catalog.

Path /api/crs/catalog/*
Health {base}/api/crs/catalog/v2/actuator/health
Swagger {base}/api/crs/catalog/swagger-ui.html
Docs OSDU CRS Catalog
14. CRS Conversion

Coordinate reference system conversion.

Path /api/crs/converter/*
Health {base}/api/crs/converter/v2/actuator/health
Swagger {base}/api/crs/converter/swagger-ui.html
Docs OSDU CRS Conversion
15. Unit

Unit of measure management.

Path /api/unit/*
Health {base}/api/unit/v2/
Swagger {base}/api/unit/swagger-ui.html
Docs OSDU Unit

Domain Data Management Services

16. Wellbore DDMS

Well, wellbore, well log, trajectory, and marker data.

Path /api/os-wellbore-ddms/ddms/v2/* (legacy), /api/os-wellbore-ddms/ddms/v3/* (current)
Health {base}/api/os-wellbore-ddms/ddms/v2/status
Swagger {base}/api/os-wellbore-ddms/docs
Docs OSDU Wellbore DDMS
17. Seismic DDMS

Seismic datasets (SEG-Y, OpenZGY), subprojects, and file metadata.

Path /seistore-svc/api/v3/*
Swagger {base}/seistore-svc/api/v3/swagger-ui.html
Docs OSDU Seismic DDMS
18. Reservoir DDMS

Reservoir models (RESQML, WITSML, PRODML). Dev environment only.

Docs OSDU Reservoir DDMS

Testing the APIs

Swagger definitions are available for each service. You can explore and test all API calls at Microsoft ADME Samples.

You can also use our Postman collection to test the APIs directly.

For environment base URLs, see ADME Technical Reference.


Last update: 2026-02-27