API Explorer — OSDU

15 core service REST APIs from the OSDU Data Platform Standard v1.0. Coordinate reference, data management, entitlements, and infrastructure services.

Authentication & Common Headers

All OSDU endpoints require a Bearer token and a data-partition-id header for multi-tenant isolation.

Authorization
Bearer {token}

OAuth 2.0 bearer token for authentication. Required on all endpoints.

data-partition-id
{partition}

Tenant isolation header. Identifies the data partition for multi-tenant access.

Content-Type
application/json

Request body format. All POST/PUT/PATCH payloads are JSON.

correlation-id
{uuid}

Optional request tracing identifier for end-to-end observability.

15 services|75 endpoints|4 groups|OSDU Standard v1.0

Storage

Data Management/api/storage/v2v27 endpoints

Record CRUD, versioning, and metadata lifecycle management. Central persistence layer for all OSDU records.

PUT/api/storage/v2/records
GET/api/storage/v2/records/{id}
DELETE/api/storage/v2/records/{id}
GET/api/storage/v2/records/{id}/versions
GET/api/storage/v2/records/{id}/{version}
POST/api/storage/v2/query/records
POST/api/storage/v2/query/records:batch

Search

Data Management/api/search/v2v22 endpoints

Full-text and geo-spatial search across all OSDU records. Powered by Elasticsearch/OpenSearch indexing.

POST/api/search/v2/query
POST/api/search/v2/query_with_cursor

Indexer

Data Management/api/indexer/v2v22 endpoints

Document indexing engine processing storage change events. Maintains search indices synchronized with Storage.

POST/api/indexer/v2/reindex
DELETE/api/indexer/v2/index/{kind}

Schema

Data Management/api/schema-service/v1v14 endpoints

Centralized schema governance and validation. Manages OSDU kind definitions and schema evolution.

POST/api/schema-service/v1/schema
GET/api/schema-service/v1/schema
GET/api/schema-service/v1/schema/{id}
PUT/api/schema-service/v1/schema

Dataset

Data Management/api/dataset/v1v14 endpoints

Dataset registration, retrieval, and storage instructions. Manages dataset metadata and access patterns.

GET/api/dataset/v1/getStorageInstructions
GET/api/dataset/v1/getRetrievalInstructions
PUT/api/dataset/v1/registerDataset
GET/api/dataset/v1/getDatasetRegistry

File

Data Management/api/file/v2v25 endpoints

Dataset file storage and retrieval. Manages binary file uploads, downloads, and file metadata.

POST/api/file/v2/files/uploadURL
POST/api/file/v2/files/metadata
GET/api/file/v2/files/{id}/downloadURL
GET/api/file/v2/files/{id}/metadata
DELETE/api/file/v2/files/{id}/metadata

Entitlements

Security & Compliance/api/entitlements/v2v210 endpoints

Group-based authorization controlling access to data, services, and user groups. Enforces ACL policies.

GET/api/entitlements/v2/groups
POST/api/entitlements/v2/groups
GET/api/entitlements/v2/groups/{group_email}
DELETE/api/entitlements/v2/groups/{group_email}
PATCH/api/entitlements/v2/groups/{group_email}
GET/api/entitlements/v2/groups/{group_email}/members
POST/api/entitlements/v2/groups/{group_email}/members
DELETE/api/entitlements/v2/groups/{group_email}/members/{member_email}
GET/api/entitlements/v2/members/{member_email}/groups
DELETE/api/entitlements/v2/members/{member_email}

Legal

Security & Compliance/api/legal/v1v17 endpoints

LegalTag compliance management ensuring data provenance, export restrictions, and data residency.

GET/api/legal/v1/legaltags
POST/api/legal/v1/legaltags
GET/api/legal/v1/legaltags/{name}
PUT/api/legal/v1/legaltags
DELETE/api/legal/v1/legaltags/{name}
POST/api/legal/v1/legaltags:validate
POST/api/legal/v1/legaltags:batchRetrieve

Secret

Security & Compliance/api/secret/v1v13 endpoints

Secure credential management for service-to-service authentication. Storage, retrieval, and rotation of secrets.

PUT/api/secret/v1/secrets/{path}
GET/api/secret/v1/secrets/{path}
DELETE/api/secret/v1/secrets/{path}

CRS Catalog

Reference Data/api/crs/catalog/v2v26 endpoints

Coordinate Reference System definitions and catalog queries. Returns CRS metadata including EPSG codes.

GET/api/crs/catalog/v2/coordinate/projected
GET/api/crs/catalog/v2/coordinate/geographic
GET/api/crs/catalog/v2/coordinate/vertical
GET/api/crs/catalog/v2/coordinate/{crsId}
GET/api/crs/catalog/v2/unit
GET/api/crs/catalog/v2/area

CRS Conversion

Reference Data/api/crs/converter/v2v23 endpoints

Point, GeoJSON, and trajectory coordinate conversions between CRS definitions. Stateless computation.

POST/api/crs/converter/v2/convert
POST/api/crs/converter/v2/convertGeoJson
POST/api/crs/converter/v2/convertTrajectory

Unit

Reference Data/api/unit/v3v34 endpoints

Unit and dimension definitions following OSDU unit catalog. Provides unit conversion for cross-domain interoperability.

GET/api/unit/v3/measurement
GET/api/unit/v3/unit
GET/api/unit/v3/unitsystem
POST/api/unit/v3/conversion

Partition

Infrastructure/api/partition/v1v15 endpoints

Multi-tenant data partition management. Each partition is an independent data namespace with isolated storage.

POST/api/partition/v1/partitions/{partitionId}
GET/api/partition/v1/partitions/{partitionId}
PATCH/api/partition/v1/partitions/{partitionId}
DELETE/api/partition/v1/partitions/{partitionId}
GET/api/partition/v1/partitions

Register

Infrastructure/api/register/v1v112 endpoints

DDMS registration, action registrations, subscription management, and topic discovery. Central service registry.

POST/api/register/v1/ddms
GET/api/register/v1/ddms
GET/api/register/v1/ddms/{id}
POST/api/register/v1/action
GET/api/register/v1/action
GET/api/register/v1/action/{id}
POST/api/register/v1/subscription
GET/api/register/v1/subscription/{id}
DELETE/api/register/v1/subscription/{id}
POST/api/register/v1/topics
GET/api/register/v1/topics
DELETE/api/register/v1/topics/{topicName}

Notification

Infrastructure/api/notification/v1v11 endpoints

Pub/sub for data change events. Subscribers receive notifications when records are created, updated, or deleted.

PUT/api/notification/v1/push-handlers/records-changed

Service Overview

All 15 OSDU Data Platform v1.0 core services at a glance.

Storage
7 ep

Record CRUD, versioning, and metadata lifecycle management. Central persistence layer for all OSDU records.

Search
2 ep

Full-text and geo-spatial search across all OSDU records. Powered by Elasticsearch/OpenSearch indexing.

Indexer
2 ep

Document indexing engine processing storage change events. Maintains search indices synchronized with Storage.

Schema
4 ep

Centralized schema governance and validation. Manages OSDU kind definitions and schema evolution.

Dataset
4 ep

Dataset registration, retrieval, and storage instructions. Manages dataset metadata and access patterns.

File
5 ep

Dataset file storage and retrieval. Manages binary file uploads, downloads, and file metadata.

Entitlements
10 ep

Group-based authorization controlling access to data, services, and user groups. Enforces ACL policies.

Legal
7 ep

LegalTag compliance management ensuring data provenance, export restrictions, and data residency.

Secret
3 ep

Secure credential management for service-to-service authentication. Storage, retrieval, and rotation of secrets.

CRS Catalog
6 ep

Coordinate Reference System definitions and catalog queries. Returns CRS metadata including EPSG codes.

CRS Conversion
3 ep

Point, GeoJSON, and trajectory coordinate conversions between CRS definitions. Stateless computation.

Unit
4 ep

Unit and dimension definitions following OSDU unit catalog. Provides unit conversion for cross-domain interoperability.

Partition
5 ep

Multi-tenant data partition management. Each partition is an independent data namespace with isolated storage.

Register
12 ep

DDMS registration, action registrations, subscription management, and topic discovery. Central service registry.

Notification
1 ep

Pub/sub for data change events. Subscribers receive notifications when records are created, updated, or deleted.

Explore the Open Footprint APIs

REST endpoints, GraphQL schema, and SDK references for Node.js, Python, and .NET

OFP API Catalog