---
title: "Subscribe a user to a cluster"
method: POST
path: "/api/clusters/{clusterName}/subscribe"
tags: ["Cloud18"]
---

# Subscribe a user to a cluster

`POST /api/clusters/{clusterName}/subscribe`

## Request

- The document declares no server URL.
- Auth: none declared. Required headers: `Authorization`

This endpoint allows a user to subscribe to a specified cluster.

## Path parameters

- `clusterName` string, required

## Headers

- `Authorization` string, required

## Request body

- ClusterUserForm
  - `grants` string
  - `password` string
  - `roles` string
  - `username` string

## Response `200`

Email sent to admin!

- string

## Other responses

- `400`: Error in request
- `401`: Error logging in to gitlab: Token credentials is not valid
- `403`: Error parsing JWT" / "Current user is not logged in via Gitlab!
- `409`: User already subscribed on peer cluster!" / "Another user already subscribed on peer cluster!
- `500`: No valid cluster" / "Peer does not have cloud18 setup!" / "Error sending email

## Changes

- **2026-07-17** `7465ea0ee21a`: 1 info
  - endpoint added
- **2023-03-31** `b57fc7b9446e`: 1 breaking
  - api path removed without deprecation

[Operation history](https://skmtc.dev/signal18/apis/signal-18-dashboard-api/changes/api/clusters/:clusterName/subscribe/post.md)

---

[API](https://skmtc.dev/signal18/apis/signal-18-dashboard-api.md) - [All operations](https://skmtc.dev/signal18/apis/signal-18-dashboard-api/llms.txt) - [OpenAPI document](https://skmtc.dev/signal18/apis/signal-18-dashboard-api/revisions/8ee8a1e31294?raw)