API reference

v2

OpenAPI 3.1.0

ClusterNest API

Download OpenAPI Document

json

Download OpenAPI Document

yaml

To get started, generate an access token via the POST /auth/token endpoint below. Afterwards include the token as Bearer in the Authorization header of all requests. e.g. Authorization: Bearer <your_access_token>.

Client Libraries

Shell

Ruby

Node.js

PHP

Python

MoreSelect from all clients

Shell Curl

Authentication

• POST Get an access token /auth/token

Organizations

• POST Create Organization /org/create
• GET Get Organization Details /org/{organization_id}
• DEL Delete Organization /org/{organization_id}
• PUT Update Organization /org/{organization_id}
• GET Get Organization Users /org/{organization_id}/users
• POST Invite User To Organization /org/{organization_id}/invite-user
• PUT Change User Role /org/{organization_id}/role/{user_id}
• DEL Remove User From Organization /org/{organization_id}/user/{user_id}
• GET Get Billing Url /org/{organization_id}/billing_transaction_id
• GET Get Invoices /org/{organization_id}/invoices
• GET Get Current Invoice /org/{organization_id}/invoices/current

OpenSearch

• GET Get Cluster /cluster/opensearch/{cluster_id}
• PUT Update Cluster /cluster/opensearch/{cluster_id}
• DEL Delete Cluster /cluster/opensearch/{cluster_id}
• POST Create Cluster /cluster/opensearch/
• GET List Clusters By Organization /cluster/opensearch/organization/{organization_id}
• GET Get Cluster Credentials /cluster/opensearch/{cluster_id}/credentials
• POST Rotate Cluster Credentials /cluster/opensearch/{cluster_id}/credentials

Prometheus

• GET Get Cluster /cluster/prometheus/{cluster_id}
• PUT Update Cluster /cluster/prometheus/{cluster_id}
• DEL Delete Cluster /cluster/prometheus/{cluster_id}
• POST Create Cluster /cluster/prometheus/
• GET List Clusters By Organization /cluster/prometheus/organization/{organization_id}
• GET Get Cluster Credentials /cluster/prometheus/{cluster_id}/credentials
• POST Rotate Cluster Credentials /cluster/prometheus/{cluster_id}/credentials