---
title: "API Endpoint Reference · RUAL Documentation"
description: "Every cluster endpoint with its method, scope and reply shape."
canonical: https://docs.rual.nl/reference/api-endpoint-reference
language: en
---

# 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:// /api/v1`. Authenticate with `Authorization: Bearer ` (or the other four accepted locations. See [API Guide](https://docs.rual.nl/cluster/api-guide#authentication)). The complete generated reference with request/response tables is at [Cluster APIs](https://docs.rual.nl/cluster/api).

### Authentication

| Method | Path | Purpose |
| --- | --- | --- |
| POST | `/api/v1/auth/signin` | Sign in, receive an access token |
| POST | `/api/v1/auth/signout` | Invalidate the current token |
| GET | `/api/v1/info` | Cluster version, flags, host info (public) |

### Blueprints & Blocks

| Method | Path | Purpose |
| --- | --- | --- |
| POST | `/api/v1/blueprints/search` | List/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}/actions` | Pending deploy actions |
| POST | `/api/v1/blueprintactions/search` | List blocks inside a blueprint |
| GET | `/api/v1/blueprintactions/{guid}` | One block's full document |
| POST | `/api/v1/blueprintactions` | Create a block |
| POST | `/api/v1/blueprintactions/unsaved/{guid}` | Save staged changes |
| DELETE | `/api/v1/blueprintactions/unsaved/{guid}` | Discard staged changes |

### Users & Access

| Method | Path | Purpose |
| --- | --- | --- |
| POST | `/api/v1/users/search` | List/search users |
| POST | `/api/v1/users/{guid}/reset-login-attempts` | Unlock a locked-out user |
| POST | `/api/v1/_system/authentication-groups/search` | List authentication groups |
| GET | `/api/v1/_system/userlogs/search` | Read user activity logs |

### Storages, Assets & Logs

| Method | Path | Purpose |
| --- | --- | --- |
| POST | `/api/v1/_system/storages` | Create a storage collection |
| POST | `/api/v1/_system/storages/search` | List storage collections |
| GET | `/api/v1/_system/storages/{guid}/count` | Document count of a storage |
| POST | `/api/v1/_system/assets/stream` | Upload an asset (multipart, ≤500MB) |
| POST | `/api/v1/_system/assets/search` | Search assets |
| DELETE | `/api/v1/_system/assets/{guid}` | Delete an asset |
| POST | `/api/v1/_system/systemlogs/search` | Read cluster system logs |
| POST | `/api/v1/_system/auditlogs` | Read the audit log |

### Fields, Templates & Validation

| Method | Path | Purpose |
| --- | --- | --- |
| POST | `/api/v1/blueprintfields` | Create a blueprint field |
| POST | `/api/v1/blueprintfields/search` | List blueprint fields |
| POST | `/api/v1/blueprinttemplates/search` | List page templates |
| PUT | `/api/v1/_system/blueprintvalidation/{guid}/{updatehash}` | Update blueprint validation rules |

### Next Steps