# PhotoPrism Cluster API

**Canonical:** https://apis.io/apis/photoprism/photoprism-cluster-api/  
**Provider:** PhotoPrism — https://apis.io/providers/photoprism/  
**Base URL:** https://demo.photoprism.app  
**Documentation:** https://docs.photoprism.app/developer-guide/api/

PhotoPrism Cluster API is one of 32 APIs that [PhotoPrism](https://apis.io/providers/photoprism/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Cluster. The published artifact set on APIs.io includes an OpenAPI specification.

The Cluster API from PhotoPrism — 7 operation(s) for cluster.

## Operations (9)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/v1/cluster` | cluster summary |
| GET | `/api/v1/cluster/health` | cluster health |
| GET | `/api/v1/cluster/metrics` | temporary cluster metrics (counts only) |
| GET | `/api/v1/cluster/nodes` | lists registered nodes |
| POST | `/api/v1/cluster/nodes/register` | registers a node, provisions DB credentials, and issues ClientSecret |
| DELETE | `/api/v1/cluster/nodes/{uuid}` | delete node by uuid |
| GET | `/api/v1/cluster/nodes/{uuid}` | get node by uuid |
| PATCH | `/api/v1/cluster/nodes/{uuid}` | update node fields |
| GET | `/api/v1/cluster/theme` | returns custom theme files as zip, if available |

## Machine-readable artifacts (1)

- **OpenAPI** — https://artifacts.apis.io/photoprism/openapi/photoprism-cluster-api-openapi.yml

## Other PhotoPrism APIs (12)

- [PhotoPrism Albums API](https://apis.io/apis/photoprism/photoprism-albums-api/)
- [PhotoPrism Assets API](https://apis.io/apis/photoprism/photoprism-assets-api/)
- [PhotoPrism Authentication API](https://apis.io/apis/photoprism/photoprism-authentication-api/)
- [PhotoPrism Cameras API](https://apis.io/apis/photoprism/photoprism-cameras-api/)
- [PhotoPrism Config API](https://apis.io/apis/photoprism/photoprism-config-api/)
- [PhotoPrism CORS API](https://apis.io/apis/photoprism/photoprism-cors-api/)
- [PhotoPrism Debug API](https://apis.io/apis/photoprism/photoprism-debug-api/)
- [PhotoPrism Download API](https://apis.io/apis/photoprism/photoprism-download-api/)
- [PhotoPrism Faces API](https://apis.io/apis/photoprism/photoprism-faces-api/)
- [PhotoPrism Files API](https://apis.io/apis/photoprism/photoprism-files-api/)
- [PhotoPrism Folders API](https://apis.io/apis/photoprism/photoprism-folders-api/)
- [PhotoPrism Images API](https://apis.io/apis/photoprism/photoprism-images-api/)

## Tags

Cluster

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/photoprism/photoprism-cluster-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/photoprism/.