content/operate/rs/references/rest-api/requests/modules/_index.md
| Method | Path | Description |
|---|---|---|
| GET | /v1/modules | List available modules |
| GET | /v1/modules/{uid} | Get a specific module |
GET /v1/modules
List available modules, i.e. modules stored within the CCS.
| Permission name | Roles |
|---|---|
| [view_cluster_modules]({{< relref "/operate/rs/references/rest-api/permissions#view_cluster_modules" >}}) | admin |
| cluster_member | |
| cluster_viewer | |
| db_member | |
| db_viewer | |
| user_manager |
GET /v1/modules
| Key | Value | Description |
|---|---|---|
| Host | 127.0.0.1:9443 | Domain name |
| Accept | */* | Accepted media type |
Returns a JSON array of [module objects]({{< relref "/operate/rs/references/rest-api/objects/module" >}}).
| Code | Description |
|---|---|
| 200 OK | No error |
GET /v1/modules/{string: uid}
Get specific available modules, i.e. modules stored within the CCS.
| Permission name | Roles |
|---|---|
| [view_cluster_modules]({{< relref "/operate/rs/references/rest-api/permissions#view_cluster_modules" >}}) | admin |
| cluster_member | |
| cluster_viewer | |
| db_member | |
| db_viewer | |
| user_manager |
GET /v1/modules/1
| Key | Value | Description |
|---|---|---|
| Host | 127.0.0.1:9443 | Domain name |
| Accept | */* | Accepted media type |
| Field | Type | Description |
|---|---|---|
| uid | integer | The module's unique ID. |
Returns a [module object]({{< relref "/operate/rs/references/rest-api/objects/module" >}}).
| Code | Description |
|---|---|
| 200 OK | No error |
| 404 Not Found | Module does not exist. |