mirror of
https://github.com/qdrant/landing_page.git
synced 2026-09-28 23:48:31 +02:00
aa1acf0acb
* Created Dev-portal pages * changed structure of documents for dev-portal section, renamed dev-portal to docs, related template changes * keeping learn section for future usage * update dev-portal and documents * added feedback and breadcrumbs components * used the docs-side menu partial on documentation pages, and added active state to the docs-header links * search console on docs * small fixes * assigned partitions, css fix * fix links on the core page * update links for cloud * update links for build * Reference -> API Reference * [WIP] Dev portal light theme (#1250) * light theme - docs side menu * background fix * wip: updating layout * layout update * light theme * card titles with a link * upd page-search package * simplified header * fixes * TOC scroll spy (#1259) * scroll spy on table of contents * packages versions fix * custom scroll spy for toc * make spy work again --------- Co-authored-by: generall <andrey@vasnetsov.com> * limit toc depth to 3 * thin scrollbar * No dev template (#1266) * divided the docs template into smaller partials, increased reusability * removed docs section, moved all to the documentation * review fixes * review fixes --------- Co-authored-by: generall <andrey@vasnetsov.com> * side panel more compact * toc margin bottom fix * Refactoring and renaming (#1277) * renamed and moved partials, fixed link * refactoring: docs-card * fix * fix urls * disable scrollbar on table of content * added scrollbar colors for light theme (#1280) * fix language * Dev portal fixes (#1285) * cards fixes * moved files, fixed paddings * fix for my fix * external header links * fix --------- Co-authored-by: trean <trean.mi@gmail.com> Co-authored-by: Andrey Vasnetsov <andrey@vasnetsov.com> Co-authored-by: davidmyriel <davidmyriel@gmail.com>
56 lines
3.3 KiB
Markdown
56 lines
3.3 KiB
Markdown
---
|
||
title: Qdrant Cloud API
|
||
weight: 26
|
||
partition: cloud
|
||
---
|
||
# Qdrant Cloud API
|
||
|
||
The Qdrant Cloud API lets you manage Cloud accounts and their respective Qdrant clusters. You can use this API to manage your clusters, authentication methods, and cloud configurations.
|
||
|
||
| REST API | Documentation |
|
||
| -------- | ------------------------------------------------------------------------------------ |
|
||
| 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: apikey <YOUR_API_KEY>'
|
||
```
|
||
|
||
This request will return a list of clusters associated with your account in JSON format.
|
||
|
||
## Cluster Management
|
||
Use these endpoints to create and manage your Qdrant database clusters. The API supports fine-grained control over cluster resources (CPU, RAM, disk), node configurations, tolerations, and other operational characteristics across all cloud providers (AWS, GCP, Azure) and their respective regions in Qdrant Cloud, as well as Hybrid Cloud.
|
||
- **Get Cluster by ID**: Retrieve detailed information about a specific cluster using the cluster ID and associated account ID.
|
||
- **Delete Cluster**: Remove a cluster, with optional deletion of backups.
|
||
- **Update Cluster**: Apply modifications to a cluster's configuration.
|
||
- **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.
|
||
- **Get Booking**: Manage hosting across various cloud providers (AWS, GCP, Azure) and their respective regions.
|
||
|
||
## 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.
|
||
- **Delete API Key**: Revoke access by deleting a specific API key.
|
||
- **Update API Key**: Modify attributes of an existing API key.
|
||
|
||
## Terraform Provider
|
||
|
||
Qdrant Cloud also provides a Terraform provider to manage your Qdrant Cloud resources. [Learn more](/documentation/infrastructure/terraform/).
|