Schema Creation APIs

Base URL: /api/v1

These APIs allow Standard Registry users to manage schemas — create, update, publish, import, export, and delete schemas associated with Guardian policies.

Authentication: All endpoints require a valid JWT Bearer token (Authorization: Bearer <token>). Obtain a token via POST /accounts/login.


Endpoints

Method
Endpoint
Description
Auth Required

GET

/schemas

List all schemas (paginated)

Yes

GET

/schema/{schemaId}

Get schema by ID

Yes

GET

/schemas/{topicId}

List schemas by topic

Yes

POST

/schemas/{topicId}

Create new schema under a topic

Yes

PUT

/schemas/

Update an existing schema

Yes

DELETE

/schemas/{schemaId}

Delete a schema

Yes

PUT

/schemas/{schemaId}/publish

Publish schema to IPFS

Yes

GET

/schemas/{schemaId}/export/message

Export schema message IDs

Yes

GET

/schemas/{schemaId}/export/file

Export schema as zip file

Yes

POST

/schemas/{topicId}/import/message

Import schema from IPFS

Yes

POST

/schemas/{topicId}/import/file

Import schema from zip file

Yes

POST

/schemas/import/message/preview

Preview schema from IPFS before import

Yes

POST

/schemas/import/file/preview

Preview schema from zip before import

Yes


Endpoint Details

See Prerequisite Steps for authentication setup.

Last updated

Was this helpful?