API Endpoint Reference

The most-used cluster endpoints on one screen — method, path, purpose. Full parameters and examples per endpoint live in the Cluster API reference.

Base URL for everything: https://<your-cluster>/api/v1. Authenticate with Authorization: Bearer <access_token> (or the other four accepted locations — see API Guide). The complete generated reference with request/response tables is at Cluster APIs.

Authentication

MethodPathPurpose
POST/api/v1/auth/signinSign in, receive an access token
POST/api/v1/auth/signoutInvalidate the current token
GET/api/v1/infoCluster version, flags, host info (public)

Blueprints & Blocks

MethodPathPurpose
POST/api/v1/blueprints/searchList/search blueprints
GET/api/v1/blueprints/{guid}One blueprint's metadata
PUT/api/v1/blueprints/update/set/active/{guid}Activate a blueprint
PUT/api/v1/blueprints/update/set/inactive/{guid}Deactivate a blueprint
GET/api/v1/blueprints/deploy/{guid}/actionsPending deploy actions
POST/api/v1/blueprintactions/searchList blocks inside a blueprint
GET/api/v1/blueprintactions/{guid}One block's full document
POST/api/v1/blueprintactionsCreate a block
POST/api/v1/blueprintactions/unsaved/{guid}Save staged changes
DELETE/api/v1/blueprintactions/unsaved/{guid}Discard staged changes

Users & Access

MethodPathPurpose
POST/api/v1/users/searchList/search users
POST/api/v1/users/{guid}/reset-login-attemptsUnlock a locked-out user
POST/api/v1/_system/authentication-groups/searchList authentication groups
GET/api/v1/_system/userlogs/searchRead user activity logs

Storages, Assets & Logs

MethodPathPurpose
POST/api/v1/_system/storagesCreate a storage collection
POST/api/v1/_system/storages/searchList storage collections
GET/api/v1/_system/storages/{guid}/countDocument count of a storage
POST/api/v1/_system/assets/streamUpload an asset (multipart, ≤500MB)
POST/api/v1/_system/assets/searchSearch assets
DELETE/api/v1/_system/assets/{guid}Delete an asset
POST/api/v1/_system/systemlogs/searchRead cluster system logs
POST/api/v1/_system/auditlogsRead the audit log

Fields, Templates & Validation

MethodPathPurpose
POST/api/v1/blueprintfieldsCreate a blueprint field
POST/api/v1/blueprintfields/searchList blueprint fields
POST/api/v1/blueprinttemplates/searchList page templates
PUT/api/v1/_system/blueprintvalidation/{guid}/{updatehash}Update blueprint validation rules

Next Steps

Cluster API Reference Every endpoint with params, examples, and scopes. API Guide Auth, conventions, errors, and workflows. Error Code Reference What each status means and what to check first.