Files
landing_page/qdrant-landing/content/documentation/cloud/authentication.md
T
Bastian Hofmann 5ca363a439 Improvement to Cloud and Hybrid Cloud docs
This significantly improves our cloud and hybrid cloud docs:

* Adds screenshots
* Better structure
* More information about payments, including stripe and azure marketplace
* Better cluster creation docs
* Account setup and invitation docs
* Monitoring docs
* Cluster upgrade docs
* Support docs
* Removed duplications
2024-08-15 17:31:04 +02:00

3.1 KiB

title, weight
title weight
Authentication 30

Authentication

This page shows you how to use the Qdrant Cloud Console to create a custom API key for a cluster. You will learn how to connect to your cluster using the new API key.

Create API keys

The API key is only shown once after creation. If you lose it, you will need to create a new one. However, we recommend rotating the keys from time to time. To create additional API keys do the following.

  1. Go to the Cloud Dashboard.
  2. Select Access Management to display available API keys, or go to the API Keys section of the Cluster detail page.
  3. Click Create and choose a cluster name from the dropdown menu.

Note: You can create a key that provides access to multiple clusters. Select desired clusters in the dropdown box.

  1. Click OK and retrieve your API key.

Test cluster access

After creation, you will receive a code snippet to access your cluster. Your generated request should look very similar to this one:

curl \
  -X GET 'https://xyz-example.eu-central.aws.cloud.qdrant.io:6333' \
  --header 'api-key: <paste-your-api-key-here>'

Open Terminal and run the request. You should get a response that looks like this:

{"title":"qdrant - vector search engine","version":"1.8.1"}

Note: You need to include the API key in the request header for every request over REST or gRPC.

Authenticate via SDK

Now that you have created your first cluster and key, you might want to access Qdrant Cloud from within your application. Our official Qdrant clients for Python, TypeScript, Go, Rust, .NET and Java all support the API key parameter.

curl \
  -X GET https://xyz-example.eu-central.aws.cloud.qdrant.io:6333 \
  --header 'api-key: <provide-your-own-key>'

# Alternatively, you can use the `Authorization` header with the `Bearer` prefix
curl \
  -X GET https://xyz-example.eu-central.aws.cloud.qdrant.io:6333 \
  --header 'Authorization: Bearer <provide-your-own-key>'
from qdrant_client import QdrantClient

qdrant_client = QdrantClient(
    "xyz-example.eu-central.aws.cloud.qdrant.io",
    api_key="<paste-your-api-key-here>",
)
import { QdrantClient } from "@qdrant/js-client-rest";

const client = new QdrantClient({
  host: "xyz-example.eu-central.aws.cloud.qdrant.io",
  apiKey: "<paste-your-api-key-here>",
});
use qdrant_client::Qdrant;

let client = Qdrant::from_url("https://xyz-example.eu-central.aws.cloud.qdrant.io:6334")
    .api_key("<paste-your-api-key-here>")
    .build()?;
import io.qdrant.client.QdrantClient;
import io.qdrant.client.QdrantGrpcClient;

QdrantClient client =
    new QdrantClient(
        QdrantGrpcClient.newBuilder(
                "xyz-example.eu-central.aws.cloud.qdrant.io",
                6334,
                true)
            .withApiKey("<paste-your-api-key-here>")
            .build());
using Qdrant.Client;

var client = new QdrantClient(
  host: "xyz-example.eu-central.aws.cloud.qdrant.io",
  https: true,
  apiKey: "<paste-your-api-key-here>"
);