Skip to main content

Redis Enterprise API

Project description

Redis Enterprise API

REST API Specifications

Key Concepts


Clusters

Redis Labs clusters are a set of nodes, typically two or more, providing database services. Clusters are inherently multi-tenant, and a single cluster can manage multiple databases accessed through individual endpoints.

Protocol and Headers


JSON Requests and Responses

The Redis Labs REST API uses the JavaScript Object Notation (JSON) for requests and responses. Some responses may have an empty body, but indicate the response with standard HTTP codes. For more information, see RFC 4627 (http://www.ietf.org/rfc/rfc4627.txt) and www.json.org.

Both requests and responses may include zero or more objects. In case the request is for a single entity, the response shall return a single JSON object, or none. In case the request if for a list of entities, the response shall return a single JSON array with 0 or more elements. Requests may be delivered with some JSON object fields missing. In this case, these fields will be assigned default values (often indicating they are not in use).

Request Headers

The Redis Labs REST API supports the following HTTP headers:

Header Supported/Required Values
Accept application/json
Content-Length Length (in bytes) of request message.
Content-Type application/json

Response Headers

The Redis Labs REST API supports the following HTTP headers:

Header Supported/Required Values
Content-Type application/json
Content-Length Length (in bytes) of request message.

API Versions


All RLEC API operations are versioned, in order to minimize the impact of backwards-incompatible API changes and to coordinate between different versions operating in parallel.

Authentication


Authentication to RLEC API occurs via Basic Auth. Provide your RLEC username and password as the basic auth credentials. All calls must be made over SSL, to port 9443.

Example Request:

curl -u "demo@redislabs.com:password" https://localhost:9443/v1/bdbs 

Common Responses


The following are common responses which may be returned in some cases regardless of any specific request.

Response Condition / Required handling
503 (Service Unavailable) Contacted node is currently not a member of any active cluster.
505 (HTTP Version Not Supported) An unsupported X-API-Version was used, see API Versions above.

noqa: E501

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

redis-enterprise-python-1.0.3.tar.gz (149.9 kB view details)

Uploaded Source

Built Distribution

redis_enterprise_python-1.0.3-py3-none-any.whl (812.7 kB view details)

Uploaded Python 3

File details

Details for the file redis-enterprise-python-1.0.3.tar.gz.

File metadata

  • Download URL: redis-enterprise-python-1.0.3.tar.gz
  • Upload date:
  • Size: 149.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.1 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.9

File hashes

Hashes for redis-enterprise-python-1.0.3.tar.gz
Algorithm Hash digest
SHA256 4eeb6fdc19e50a24e165a0b4d990ab02a4f3c80e93f297c69450863544bb5706
MD5 9b7ac7141443f802d691954646da10ae
BLAKE2b-256 df4ac53762e58810c76fcbbc779c14e145da65435dad184046feb50a55bd5ed1

See more details on using hashes here.

File details

Details for the file redis_enterprise_python-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: redis_enterprise_python-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 812.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.1 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.7.9

File hashes

Hashes for redis_enterprise_python-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 692100693647f28343edb85427ffba9884af5a08d0a3cc7be4de656b8b1f47c8
MD5 ab372dc625bddd9a356d2f4c36b9fcda
BLAKE2b-256 4daeab4ed6f09118c50d9f7a827a4bc06627ce3c9ab46384e1c6f4736dc6135f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page