Skip to main content

REST - /v1/.well-known

caution
This section of the documentation is deprecated and will be removed in the future.
Please refer to the OpenAPI documentation for the most up-to-date information.

For client examples, see this section.

OpenID Configuration

If OpenID Connect (OIDC) authentication is enabled, the endpoint returns configuration details.

If a token is configured, the endpoint redirects to it.

Usage

The discovery endpoint accepts a GET request:

GET /v1/.well-known/openid-configuration

If there is an OIDC provider, the endpoint returns the following fields:

  • href: The reference to the client.
  • cliendID: The ID of the client.

If there is no OIDC provider, the endpoint returns a 404 HTTP status code.

Example

import weaviate

client = weaviate.connect_to_local()

open_id_configuration = client.get_open_id_configuration()

print(open_id_configuration)

finally:
client.close()

If OIDC is configured, the endpoint returns a document like this:

{
"href": "http://my-token-issuer/auth/realms/my-weaviate-usecase",
"cliendID": "my-weaviate-client"
}

Liveness

The live endpoint checks if the application is alive. You can use it for a Kubernetes liveness probe.

Usage

The endpoint accepts a GET request:

GET /v1/.well-known/live

The endpoint returns HTTP status code 200 if the application is able to respond to HTTP requests.

Example

import weaviate

client = weaviate.connect_to_local()

print(client.is_live())

finally:
client.close()

The endpoint returns HTTP status code 200 if the application is able to respond to HTTP requests.

Readiness

The ready endpoint checks if the application is ready to receive traffic. You can use it for Kubernetes readiness probe.

Usage

The discovery endpoint accepts a GET request:

GET /v1/.well-known/ready

The endpoint returns HTTP status code 200 if the application is able to respond to HTTP requests. If the application is currently unable to serve traffic, the endpoint returns HTTP status code 503.

If the application is unavailable and you have horizontal replicas of Weaviate that can receive traffic, redirect traffic to one of the replicas.

Example

import weaviate

client = weaviate.connect_to_local()

print(client.is_ready())

finally:
client.close()

The endpoint returns HTTP status code 200 if the application is able to respond to HTTP requests.

Questions and feedback

If you have any questions or feedback, let us know in the user forum.