Key Concepts
Dataset Reference
Datasets are identified as
namespace/name@version (e.g., ethereum/mainnet@1.0.0)- Semantic versions - User-defined versions like
1.0.0,2.1.3 latest- System-managed, points to highest semantic versiondev- Development tag for testing, manually updated
- Register - Store manifest and create version tag
- Deploy - Schedule extraction job to sync data
- Monitor - Track job progress and sync state
- Restore - Recover metadata from storage if needed
Core Operations
Register
Store dataset manifests with version tags
Deploy
Start extraction jobs for data sync
List
View all registered datasets
Inspect
Get detailed dataset information
Register Datasets
Register a manifest as a named dataset with version tagging:Deploy Datasets
Schedule an extraction job to sync blockchain data:List Datasets
View all registered datasets:Inspect Datasets
Get detailed information about a specific dataset version:List Dataset Versions
View all available versions for a dataset:View Dataset Manifest
Retrieve the raw manifest JSON:Restore from Storage
Re-index dataset metadata from existing data in object storage:- Recovery after metadata database loss
- Setting up new system with pre-existing data
- Re-syncing after storage restoration
- Migrating data from another system
Restore from Custom Storage Path
For data at non-default storage paths (e.g., after migration or importing from another system):List Dataset Jobs
View all jobs for a specific dataset:API Reference
Dataset management endpoints:| Endpoint | Method | Description |
|---|---|---|
/datasets | GET | List all datasets |
/datasets | POST | Register a dataset |
/datasets/{namespace}/{name}/versions | GET | List dataset versions |
/datasets/{namespace}/{name}/versions/{revision} | GET | Get dataset details |
/datasets/{namespace}/{name}/versions/{revision}/deploy | POST | Deploy dataset |
/datasets/{namespace}/{name}/versions/{revision}/manifest | GET | Get manifest JSON |
/datasets/{namespace}/{name}/versions/{revision}/restore | POST | Restore dataset |
/datasets/{namespace}/{name}/versions/{revision}/jobs | GET | List dataset jobs |
For complete API schemas, see the Admin API OpenAPI specification.
Next Steps
Job Management
Monitor and control extraction jobs
Worker Management
Monitor worker health and availability