mirror of
https://github.com/qdrant/landing_page.git
synced 2026-09-25 22:18:30 +02:00
fix Cloud API doc
This commit is contained in:
+26
-3
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Cloud API Reference
|
||||
weight: 100
|
||||
title: Qdrant Cloud API
|
||||
weight: 10
|
||||
---
|
||||
# Qdrant Cloud API
|
||||
|
||||
@@ -10,6 +10,29 @@ The Qdrant Cloud API lets you manage Cloud accounts and their respective Qdrant
|
||||
| -------- | ------------------------------------------------------------------------------------ |
|
||||
| v.0.1.0 | [OpenAPI Specification](https://cloud.qdrant.io/pa/v1/docs) |
|
||||
|
||||
**Note:** This is not the Qdrant REST API. For core product APIs & SDKs, see our list of [interfaces](/documentation/interfaces/)
|
||||
|
||||
## Authentication: Connecting to Cloud API
|
||||
To interact with the Qdrant Cloud API, you must authenticate using an API key. Each request to the API must include the API key in the **Authorization** header. The API key acts as a bearer token and grants access to your account’s resources.
|
||||
|
||||
You can create a Cloud API key in the Cloud Console UI. Go to **Access Management** > **Qdrant Cloud API Keys**.
|
||||

|
||||
|
||||
**Note:** Ensure that the API key is kept secure and not exposed in public repositories or logs. Once authenticated, the API allows you to manage clusters, collections, and perform other operations available to your account.
|
||||
|
||||
## Sample API Request
|
||||
|
||||
Here's an example of a basic request to **list all clusters** in your Qdrant Cloud account:
|
||||
|
||||
```bash
|
||||
curl -X 'GET' \
|
||||
'https://cloud.qdrant.io/pa/v1/accounts/<YOUR_ACCOUNT_ID>/clusters' \
|
||||
-H 'accept: application/json' \
|
||||
-H 'Authorization: <YOUR_API_KEY>'
|
||||
```
|
||||
|
||||
This request will return a list of clusters associated with your account in JSON format.
|
||||
|
||||
## Cluster Management
|
||||
In addition to basic CRUD operations, the API supports fine-grained control over cluster resources (CPU, RAM, disk), node configurations, tolerations, and other operational characteristics.
|
||||
- **Get Cluster by ID**: Retrieve detailed information about a specific cluster using the cluster ID and associated account ID.
|
||||
@@ -18,7 +41,7 @@ In addition to basic CRUD operations, the API supports fine-grained control over
|
||||
- **List Clusters**: Get all clusters associated with a specific account, filtered by region or other criteria.
|
||||
- **Create Cluster**: Add new clusters to the account with configurable parameters such as nodes, cloud provider, and regions.
|
||||
|
||||
## Authentication Management
|
||||
## Cluster Authentication Management
|
||||
Use these endpoints to manage your cluster API keys.
|
||||
- **List API Keys**: Retrieve all API keys associated with an account.
|
||||
- **Create API Key**: Generate a new API key for programmatic access.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 74 KiB |
Reference in New Issue
Block a user