Skip to content
Mengi CloudMengi Cloud Docs

List Cluster Resources

GET
/clusters/{cluster_id}/resources
curl --request GET \
  --url 'https://api.mengi.cloud/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/resources?kind=example&page=1&page_size=50&include_system=false'

List a cluster’s Kubernetes resources of one kind (paginated).

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
cluster_id
required
Cluster Id
string format: uuid

Query Parameters

Section titled “Query Parameters”
kind
required
Kind

Resource kind (nodes, pods, services, deployments, statefulsets, daemonsets, ingresses)

string

Resource kind (nodes, pods, services, deployments, statefulsets, daemonsets, ingresses)

page
Page
integer
default: 1 >= 1
page_size
Page Size
integer
default: 50 >= 1 <= 200
include_system
Include System

Include system namespaces

boolean

Include system namespaces

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Examplegenerated
example

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}