Zomes API

📋 Table of Contents

• Overview

• Zome Management

• Zome Operations

• Error Responses

Overview

The Zomes API provides zome (application module) management for the STAR ecosystem. It handles zomes as reusable application components.

Zome Management

Get All Zomes

GET /api/zomes
Authorization: Bearer YOUR_TOKEN

Get Zome by ID

GET /api/zomes/{zomeId}
Authorization: Bearer YOUR_TOKEN

Create Zome

POST /api/zomes
Authorization: Bearer YOUR_TOKEN

Update Zome

PUT /api/zomes/{zomeId}
Authorization: Bearer YOUR_TOKEN

Delete Zome

DELETE /api/zomes/{zomeId}
Authorization: Bearer YOUR_TOKEN

Zome Operations

Deploy Zome

POST /api/zomes/{zomeId}/deploy
Authorization: Bearer YOUR_TOKEN

Execute Zome Function

POST /api/zomes/{zomeId}/execute
Authorization: Bearer YOUR_TOKEN

Get Zome Functions

GET /api/zomes/{zomeId}/functions
Authorization: Bearer YOUR_TOKEN

Error Responses

Zome Not Found

{
  "result": null,
  "isError": true,
  "message": "Zome not found"
}

---

Navigation

← Previous: Holons API | Next: Chapters API →