diff --git a/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md b/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md index 57a901aa0f..2e6bb4f7eb 100644 --- a/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md +++ b/content/operate/rs/7.4/references/rest-api/objects/bdb/_index.md @@ -64,14 +64,14 @@ An API object that represents a managed database in the cluster. | created_time | string; The date and time the database was created (read-only) | | data_internode_encryption | boolean; Should the data plane internode communication for this database be encrypted | | data_persistence | Database on-disk persistence policy. For snapshot persistence, a [snapshot_policy]({{< relref "/operate/rs/references/rest-api/objects/bdb/snapshot_policy" >}}) must be provided
Values:
**'disabled'**
'snapshot'
'aof' | -| dataset_import_sources | [complex object]({{< relref "/operate/rs/references/rest-api/objects/bdb/dataset_import_sources" >}}); Array of source file location description objects to import from when performing an import action. This is write-only and cannot be read after set.
Call GET /jsonschema to retrieve the object's structure. | +| dataset_import_sources | [complex object]({{< relref "/operate/rs/references/rest-api/objects/bdb/dataset_import_sources" >}}); Array of source file location description objects to import from when performing an import action. This is write-only and cannot be read after set.
Call `GET /v1/jsonschema` to retrieve the object's structure. | | db_conns_auditing | boolean; Enables/deactivates [database connection auditing]({{< relref "/operate/rs/security/audit-events" >}}) | | default_user | boolean (default: true); Allow/disallow a default user to connect | | disabled_commands | string (default: ); Redis commands which are disabled in db | | dns_address_master | string; Database private address endpoint FQDN (read-only) (deprecated as of Redis Enterprise v4.3.3) | | email_alerts | boolean (default: false); Send email alerts for this DB | | endpoint | string; Latest bound endpoint. Used when reconfiguring an endpoint via update | -| endpoint_ip | complex object; External IP addresses of node hosting the BDB's endpoint. `GET` `/jsonschema` to retrieve the object's structure. (read-only) (deprecated as of Redis Enterprise v4.3.3) | +| endpoint_ip | complex object; External IP addresses of node hosting the BDB's endpoint. `GET /v1/jsonschema` to retrieve the object's structure. (read-only) (deprecated as of Redis Enterprise v4.3.3) | | endpoint_node | integer; Node UID hosting the BDB's endpoint (read-only) (deprecated as of Redis Enterprise v4.3.3) | | endpoints | array; List of database access endpoints (read-only)
**uid**: Unique identification of this source
**dns_name**: Endpoint’s DNS name
**port**: Endpoint’s TCP port number
**addr**: Endpoint’s accessible addresses
**proxy_policy**: The policy used for proxy binding to the endpoint
**exclude_proxies**: List of proxies to exclude
**include_proxies**: List of proxies to include
**addr_type**: Indicates if the endpoint is based on internal or external IPs
**oss_cluster_api_preferred_ip_type**: Indicates preferred IP type in the OSS cluster API: internal/external
**oss_cluster_api_preferred_endpoint_type**: Indicates preferred endpoint type in the OSS cluster API: ip/hostname | | enforce_client_authentication | Require authentication of client certificates for SSL connections to the database. If set to 'enabled', a certificate should be provided in either authentication_ssl_client_certs or authentication_ssl_crdt_certs
Values:
**'enabled'**
'disabled' | diff --git a/content/operate/rs/7.4/references/rest-api/permissions.md b/content/operate/rs/7.4/references/rest-api/permissions.md index a311253135..f52924963c 100644 --- a/content/operate/rs/7.4/references/rest-api/permissions.md +++ b/content/operate/rs/7.4/references/rest-api/permissions.md @@ -14,7 +14,7 @@ url: '/operate/rs/7.4/references/rest-api/permissions/' Some Redis Enterprise [REST API requests]({{< relref "/operate/rs/references/rest-api/requests" >}}) may require the user to have specific permissions. -Administrators can assign a predefined role to a user with the [Cluster Manager UI]({{< relref "/operate/rs/security/access-control/create-users" >}}) or a [`PUT /users/{uid}` API request]({{< relref "/operate/rs/references/rest-api/requests/users#put-user" >}}) to grant necessary permissions to them. +Administrators can assign a predefined role to a user with the [Cluster Manager UI]({{< relref "/operate/rs/security/access-control/create-users" >}}) or a [`PUT /v1/users/{uid}` API request]({{< relref "/operate/rs/references/rest-api/requests/users#put-user" >}}) to grant necessary permissions to them. ## Roles diff --git a/content/operate/rs/7.4/references/rest-api/requests/actions/_index.md b/content/operate/rs/7.4/references/rest-api/requests/actions/_index.md index 4cde17c18b..4569bc1ca0 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/actions/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/actions/_index.md @@ -37,7 +37,7 @@ Get the status of all actions (executing, queued, or completed) on all entities #### Example HTTP request ``` -GET /actions +GET /v1/actions ``` ### Response {#get-all-response} @@ -107,7 +107,7 @@ Get the status of a currently executing, queued, or completed action. #### Example HTTP request ``` -GET /actions/{uid} +GET /v1/actions/{uid} ``` #### URL parameters diff --git a/content/operate/rs/7.4/references/rest-api/requests/actions/bdb.md b/content/operate/rs/7.4/references/rest-api/requests/actions/bdb.md index f995b5c352..f8a6965ca2 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/actions/bdb.md +++ b/content/operate/rs/7.4/references/rest-api/requests/actions/bdb.md @@ -35,7 +35,7 @@ Get the status of all currently executing, pending, or completed state-machine-r #### Example HTTP request ``` -GET /actions/bdb/1 +GET /v1/actions/bdb/1 ``` #### URL parameters diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/_index.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/_index.md index 6197235720..e74cba831b 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/_index.md @@ -132,7 +132,7 @@ Get a single database. #### Example HTTP request ```sh -GET /bdbs/1 +GET /v1/bdbs/1 ``` #### Headers @@ -201,7 +201,7 @@ To track this request's progress, poll the [`/actions/` endpoint]({{ #### Example HTTP request ```sh -PUT /bdbs/1 +PUT /v1/bdbs/1 ``` #### Headers @@ -309,7 +309,7 @@ If called with the `dry_run` URL query string, the function will validate the [B #### Example HTTP request ```sh -PUT /bdbs/1/reset_admin_pass +PUT /v1/bdbs/1/reset_admin_pass ``` The above request resets the admin password after updating the database. @@ -426,7 +426,7 @@ The cluster will use default configuration for any missing database field. The c #### Example HTTP request ```sh -POST /bdbs +POST /v1/bdbs ``` #### Headers @@ -628,7 +628,7 @@ Delete an active database. #### Example HTTP request ```sh -DELETE /bdbs/1 +DELETE /v1/bdbs/1 ``` #### Headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/backup_reset_status.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/backup_reset_status.md index 22ddb1ea4a..9b070d4983 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/backup_reset_status.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/backup_reset_status.md @@ -35,7 +35,7 @@ Resets the database's `backup_status` to idle if a backup is not in progress and #### Example HTTP request ```sh -PUT /bdbs/1/actions/backup_reset_status +PUT /v1/bdbs/1/actions/backup_reset_status ``` #### Headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/export.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/export.md index 1606299ff2..36156a2671 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/export.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/export.md @@ -35,7 +35,7 @@ Initiate a database export. #### Example HTTP request ```sh -POST /bdbs/1/actions/export +POST /v1/bdbs/1/actions/export ``` #### Headers @@ -59,7 +59,7 @@ The request body should contain a JSON object with the following export paramete | Field | Type | Description | |-------|------|-------------| -| export_location | [backup_location/export_location]({{< relref "/operate/rs/references/rest-api/objects/bdb/backup_location" >}}) object | Details for the export destination. Call [`GET /jsonschema`]({{< relref "/operate/rs/references/rest-api/requests/jsonschema#get-jsonschema" >}}) on the bdb object and review the `backup_location` field to retrieve the object's structure. | +| export_location | [backup_location/export_location]({{< relref "/operate/rs/references/rest-api/objects/bdb/backup_location" >}}) object | Details for the export destination. Call [`GET /v1/jsonschema`]({{< relref "/operate/rs/references/rest-api/requests/jsonschema#get-jsonschema" >}}) on the bdb object and review the `backup_location` field to retrieve the object's structure. | | email_notification | boolean | Enable/disable an email notification on export failure/ completion. (optional) | ##### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/export_reset_status.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/export_reset_status.md index d2857eec93..dd649ddce6 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/export_reset_status.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/export_reset_status.md @@ -33,7 +33,7 @@ Resets the database's `export_status` to idle if an export is not in progress an #### Example HTTP request ```sh -PUT /bdbs/1/actions/export_reset_status +PUT /v1/bdbs/1/actions/export_reset_status ``` #### Request headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/import.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/import.md index 261eb3af9c..3e4b5cf7f0 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/import.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/import.md @@ -35,7 +35,7 @@ Initiate a manual import process. #### Example HTTP request ```sh -POST /bdbs/1/actions/import +POST /v1/bdbs/1/actions/import ``` #### Headers @@ -58,7 +58,7 @@ The request _may_ contain a subset of the [BDB JSON object]({{< relref "/operate | Field | Type | Description | |-------|------|-------------| -| dataset_import_sources | array of [dataset_import_sources]({{< relref "/operate/rs/references/rest-api/objects/bdb/dataset_import_sources" >}}) objects | Details for the import sources. Call [`GET /jsonschema`]({{< relref "/operate/rs/references/rest-api/requests/jsonschema#get-jsonschema" >}}) on the bdb object and review the `dataset_import_sources` field to retrieve the object's structure. | +| dataset_import_sources | array of [dataset_import_sources]({{< relref "/operate/rs/references/rest-api/objects/bdb/dataset_import_sources" >}}) objects | Details for the import sources. Call [`GET /v1/jsonschema`]({{< relref "/operate/rs/references/rest-api/requests/jsonschema#get-jsonschema" >}}) on the bdb object and review the `dataset_import_sources` field to retrieve the object's structure. | | email_notification | boolean | Enable/disable an email notification on import failure/ completion. (optional) | {{}} diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/import_reset_status.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/import_reset_status.md index 467fe94fb7..a56b78999d 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/import_reset_status.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/import_reset_status.md @@ -33,7 +33,7 @@ Reset the database’s `import_status` to idle if a backup is not in progress an #### Example HTTP request ```sh -PUT /bdbs/1/actions/import_reset_status +PUT /v1/bdbs/1/actions/import_reset_status ``` diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/optimize_shards_placement.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/optimize_shards_placement.md index bade7b3669..47978f615c 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/optimize_shards_placement.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/optimize_shards_placement.md @@ -36,7 +36,7 @@ Get optimized shards placement for the given database. #### Example HTTP request ```sh -GET /bdbs/1/actions/optimize_shards_placement +GET /v1/bdbs/1/actions/optimize_shards_placement ``` #### Query parameters @@ -55,12 +55,12 @@ Include query parameters in a `GET` request to generate an optimized shard place The following example request includes `shards_count` and `memory_size` as query parameters: ```sh -GET /bdbs/1/actions/optimize_shards_placement?shards_count=10&memory_size=10000 +GET /v1/bdbs/1/actions/optimize_shards_placement?shards_count=10&memory_size=10000 ``` ### Response {#get-response} -To rearrange the database shards, you can submit the blueprint returned in this response body as the `shards_blueprint` field in the [`PUT` `/bdbs/{uid}`](#put-bdbs-rearrange-shards) request. +To rearrange the database shards, you can submit the blueprint returned in this response body as the `shards_blueprint` field in the [`PUT` `/v1/bdbs/{uid}`](#put-bdbs-rearrange-shards) request. #### Example JSON body @@ -125,9 +125,9 @@ To rearrange the database shards, you can submit the blueprint returned in this ## Rearrange database shards {#put-bdbs-rearrange-shards} -Use the blueprint returned by the [`GET` `/bdbs/{uid}/actions/optimize_shards_placement`]({{< relref "/operate/rs/references/rest-api/requests/bdbs/actions/optimize_shards_placement#get-bdbs-actions-optimize-shards-placement" >}}) request as the value of the `shards_blueprint` field to rearrange the database shards. +Use the blueprint returned by the [`GET` `/v1/bdbs/{uid}/actions/optimize_shards_placement`]({{< relref "/operate/rs/references/rest-api/requests/bdbs/actions/optimize_shards_placement#get-bdbs-actions-optimize-shards-placement" >}}) request as the value of the `shards_blueprint` field to rearrange the database shards. -To ensure that the optimized shard placement is relevant for the current cluster state, pass the `cluster-state-id`, taken from the response header of the `GET` request, in the [`PUT` `/bdbs/{uid}`]({{< relref "/operate/rs/references/rest-api/requests/bdbs#put-bdbs" >}}) request headers. +To ensure that the optimized shard placement is relevant for the current cluster state, pass the `cluster-state-id`, taken from the response header of the `GET` request, in the [`PUT` `/v1/bdbs/{uid}`]({{< relref "/operate/rs/references/rest-api/requests/bdbs#put-bdbs" >}}) request headers. The cluster will reject the update if its state was changed since the optimal shards placement was obtained. @@ -136,7 +136,7 @@ The cluster will reject the update if its state was changed since the optimal sh #### Example HTTP request ```sh -PUT /bdbs/1 +PUT /v1/bdbs/1 ``` #### Headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/recover.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/recover.md index 6db740bd4c..df25db46d5 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/recover.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/actions/recover.md @@ -36,7 +36,7 @@ Fetches the recovery plan for a database. The recovery plan provides information #### Example HTTP request ```sh -GET /bdbs/1/actions/recover +GET /v1/bdbs/1/actions/recover ``` #### URL parameters @@ -113,7 +113,7 @@ If the request body is empty, the database will be recovered automatically: #### Example HTTP request ```sh -POST /bdbs/1/actions/recover +POST /v1/bdbs/1/actions/recover ``` #### Example request body diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/alerts.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/alerts.md index e1d66fd19a..547f533238 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/alerts.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/alerts.md @@ -35,7 +35,7 @@ Get all alert states for all databases. #### Example HTTP request - GET /bdbs/alerts + GET /v1/bdbs/alerts #### Request headers @@ -93,7 +93,7 @@ Get all alert states for a database. #### Example HTTP request - GET /bdbs/alerts/1 + GET /v1/bdbs/alerts/1 #### Request headers @@ -149,7 +149,7 @@ Get a database alert state. #### Example HTTP request - GET /bdbs/alerts/1/bdb_size + GET /v1/bdbs/alerts/1/bdb_size #### Request headers @@ -214,7 +214,7 @@ If passed with the dry_run URL query string, the function will validate the aler #### Example HTTP request - POST /bdbs/alerts/1 + POST /v1/bdbs/alerts/1 #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/crdt_sources-alerts.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/crdt_sources-alerts.md index 8b2a7d9ee4..e33c683fe5 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/crdt_sources-alerts.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/crdt_sources-alerts.md @@ -35,7 +35,7 @@ Get all alert states for all CRDT sources of all CRDBs. #### Example HTTP request - GET /bdbs/crdt_sources/alerts + GET /v1/bdbs/crdt_sources/alerts #### Request headers @@ -93,7 +93,7 @@ Get all alert states for all crdt sources for a specific local bdb of a CRDB. #### Example HTTP request - GET /bdbs/crdt_sources/alerts/1 + GET /v1/bdbs/crdt_sources/alerts/1 #### Request headers @@ -156,7 +156,7 @@ of a CRDB. #### Example HTTP request - GET /bdbs/crdt_sources/alerts/1/2 + GET /v1/bdbs/crdt_sources/alerts/1/2 #### Request headers @@ -219,7 +219,7 @@ Get a BDB alert state. #### Example HTTP request - GET /bdbs/crdt_sources/alerts/1/2/crdt_src_syncer_connection_error + GET /v1/bdbs/crdt_sources/alerts/1/2/crdt_src_syncer_connection_error #### Request headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/debuginfo.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/debuginfo.md index dc98fd5db6..d31b8c1916 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/debuginfo.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/debuginfo.md @@ -33,7 +33,7 @@ Downloads a tar file that contains debug info from all databases. #### Example HTTP request - GET /bdbs/debuginfo + GET /v1/bdbs/debuginfo ### Response {#get-all-response} @@ -71,7 +71,7 @@ Downloads a tar file that contains debug info from the database specified by `bd #### Example HTTP request - GET /bdbs/1/debuginfo + GET /v1/bdbs/1/debuginfo ### Response {#get-response} diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/config.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/config.md index 15ee84d740..a30f376ba8 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/config.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/config.md @@ -32,7 +32,7 @@ Use the module runtime configuration command (if defined) to configure new argum #### Example HTTP request - POST /bdbs/1/modules/config + POST /v1/bdbs/1/modules/config #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/upgrade.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/upgrade.md index ac5a1ecc4a..36c0f569e5 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/upgrade.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/modules/upgrade.md @@ -32,7 +32,7 @@ Upgrades module version on a specific BDB. #### Example HTTP request - POST /bdbs/1/modules/upgrade + POST /v1/bdbs/1/modules/upgrade #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/passwords.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/passwords.md index c84a717893..3b3aa9c49e 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/passwords.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/passwords.md @@ -34,7 +34,7 @@ Set a single password for the bdb's default user (i.e., for `AUTH` `` aut #### Example HTTP request - POST /bdbs/1/passwords + POST /v1/bdbs/1/passwords #### Example JSON body @@ -154,7 +154,7 @@ Delete a password from the bdb's default user (i.e., for `AUTH` ` #### Example HTTP request - DELETE /bdbs/1/passwords + DELETE /v1/bdbs/1/passwords #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/peer_stats.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/peer_stats.md index 188172a3fc..dfdece6abe 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/peer_stats.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/peer_stats.md @@ -36,7 +36,7 @@ Get statistics for all peer instances of a local CRDB instance. #### Example HTTP request ```sh -GET /bdbs/1/peer_stats?interval=5min +GET /v1/bdbs/1/peer_stats?interval=5min ``` #### Headers @@ -128,7 +128,7 @@ Get statistics for a specific CRDB peer instance. #### Example HTTP request ```sh -GET /bdbs/1/peer_stats/3?interval=5min +GET /v1/bdbs/1/peer_stats/3?interval=5min ``` #### Headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/replica_sources-alerts.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/replica_sources-alerts.md index 09c7ec5a8a..e1cd90af13 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/replica_sources-alerts.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/replica_sources-alerts.md @@ -35,7 +35,7 @@ Get all alert states for all replica sources of all BDBs. #### Example HTTP request - GET /bdbs/replica_sources/alerts + GET /v1/bdbs/replica_sources/alerts #### Request headers @@ -95,7 +95,7 @@ Get all alert states for all replica sources of a specific bdb. #### Example HTTP request - GET /bdbs/replica_sources/alerts/1 + GET /v1/bdbs/replica_sources/alerts/1 #### Request headers @@ -157,7 +157,7 @@ Get all alert states for a specific replica source of a bdb. #### Example HTTP request - GET /bdbs/replica_sources/alerts/1/2 + GET /v1/bdbs/replica_sources/alerts/1/2 #### Request headers @@ -220,7 +220,7 @@ Get a replica source alert state of a specific bdb. #### Example HTTP request - GET /bdbs/replica_sources/alerts/1/2/replica_src_syncer_connection_error + GET /v1/bdbs/replica_sources/alerts/1/2/replica_src_syncer_connection_error #### Request headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/shards.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/shards.md index 389b98d11e..2cf90147c5 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/shards.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/shards.md @@ -26,7 +26,7 @@ Gets the status for all shards that belong to the specified database. #### Example HTTP request - GET /bdbs/1/shards?extra_info_keys=used_memory_rss&extra_info_keys=connected_clients + GET /v1/bdbs/1/shards?extra_info_keys=used_memory_rss&extra_info_keys=connected_clients #### Request headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/stats/_index.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/stats/_index.md index 85395d5de1..eb537d50f7 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/stats/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/stats/_index.md @@ -37,7 +37,7 @@ Get statistics for all databases. #### Example HTTP request ```sh -GET /bdbs/stats?interval=1hour&stime=2014-08-28T10:00:00Z +GET /v1/bdbs/stats?interval=1hour&stime=2014-08-28T10:00:00Z ``` #### Headers @@ -178,7 +178,7 @@ Get statistics for a specific database. #### Example HTTP request ```sh -GET /bdbs/stats/1?interval=1hour&stime=2014-08-28T10:00:00Z +GET /v1/bdbs/stats/1?interval=1hour&stime=2014-08-28T10:00:00Z ``` #### Headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/stats/last.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/stats/last.md index 6834be9275..7cb03b3f31 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/stats/last.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/stats/last.md @@ -37,12 +37,12 @@ Get the most recent statistics for all databases. 1. Without metrics filter (returns all metrics by default) ``` - GET /bdbs/stats/last + GET /v1/bdbs/stats/last ``` 2. With metrics filter ``` - GET /bdbs/stats/last?metrics=no_of_keys,used_memory + GET /v1/bdbs/stats/last?metrics=no_of_keys,used_memory ``` #### Request headers @@ -154,7 +154,7 @@ Get the most recent statistics for a specific database. #### Example HTTP request ```sh -GET /bdbs/stats/last/1?metrics=no_of_keys,used_memory +GET /v1/bdbs/stats/last/1?metrics=no_of_keys,used_memory ``` #### Request headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/sync_source_stats.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/sync_source_stats.md index 05dfe92c2a..0fc59b9e7f 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/sync_source_stats.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/sync_source_stats.md @@ -36,7 +36,7 @@ Get stats for all syncer sources of a local database. #### Example HTTP request ```sh -GET /bdbs/1/sync_source_stats?interval=5min +GET /v1/bdbs/1/sync_source_stats?interval=5min ``` #### Headers @@ -119,7 +119,7 @@ Get stats for a specific syncer (Replica Of) instance. #### Example HTTP request ```sh -GET /bdbs/1/sync_source_stats/1?interval=5min +GET /v1/bdbs/1/sync_source_stats/1?interval=5min ``` #### Headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/bdbs/upgrade.md b/content/operate/rs/7.4/references/rest-api/requests/bdbs/upgrade.md index 0a5467b93c..f01b0616e8 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bdbs/upgrade.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bdbs/upgrade.md @@ -32,7 +32,7 @@ Upgrade a database. #### Example HTTP request - POST /bdbs/1/upgrade + POST /v1/bdbs/1/upgrade #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/bootstrap/_index.md b/content/operate/rs/7.4/references/rest-api/requests/bootstrap/_index.md index 2c0cc65125..d14ca796d8 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bootstrap/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bootstrap/_index.md @@ -35,7 +35,7 @@ Once the node is part of an active cluster, authentication is required. #### Example HTTP request ```sh -GET /bootstrap +GET /v1/bootstrap ``` #### Headers @@ -156,7 +156,7 @@ complete. #### Example HTTP request ```sh -POST /bootstrap/create_cluster +POST /v1/bootstrap/create_cluster ``` #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/bootstrap/validate.md b/content/operate/rs/7.4/references/rest-api/requests/bootstrap/validate.md index ccf68f5fca..c75ef51c79 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/bootstrap/validate.md +++ b/content/operate/rs/7.4/references/rest-api/requests/bootstrap/validate.md @@ -29,7 +29,7 @@ returns with a response. #### Example HTTP request - POST /bootstrap/validate/join_cluster + POST /v1/bootstrap/validate/join_cluster #### Request body diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/_index.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/_index.md index b309ff922e..98da5b29ce 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/_index.md @@ -34,7 +34,7 @@ Get cluster info. #### Example HTTP request - GET /cluster + GET /v1/cluster #### Request headers @@ -91,7 +91,7 @@ changes. #### Example HTTP request - PUT /cluster + PUT /v1/cluster #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/actions.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/actions.md index 018567a723..a047d7eba8 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/actions.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/actions.md @@ -35,7 +35,7 @@ Get the status of all currently executing, queued, or completed cluster actions. #### Example HTTP request - GET /cluster/actions + GET /v1/cluster/actions ### Response {#get-all-response} @@ -78,7 +78,7 @@ Get the status of a currently executing, queued, or completed cluster action. #### Example HTTP request - GET /cluster/actions/action_name + GET /v1/cluster/actions/action_name #### URL parameters @@ -131,7 +131,7 @@ removed as soon as the new one is submitted. #### Example HTTP request - POST /cluster/actions/action_name + POST /v1/cluster/actions/action_name #### URL parameters diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/alerts.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/alerts.md index b1f62dc67a..897e83948e 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/alerts.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/alerts.md @@ -33,7 +33,7 @@ Get all alert states for the cluster object. #### Example HTTP request - GET /cluster/alerts + GET /v1/cluster/alerts #### Request headers @@ -91,7 +91,7 @@ Get a cluster alert state. #### Example HTTP request - GET /cluster/alerts/cluster_too_few_nodes_for_replication + GET /v1/cluster/alerts/cluster_too_few_nodes_for_replication #### Request headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/auditing-db-conns.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/auditing-db-conns.md index 9091bf52e6..38207d4bdd 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/auditing-db-conns.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/auditing-db-conns.md @@ -34,7 +34,7 @@ Gets the configuration settings for [auditing database connections]({{< relref " #### Example HTTP request - GET /cluster/auditing/db_conns + GET /v1/cluster/auditing/db_conns #### Request headers @@ -91,7 +91,7 @@ Updates the configuration settings for [auditing database connections]({{< relre #### Example HTTP request - PUT /cluster/auditing/db_conns + PUT /v1/cluster/auditing/db_conns #### Example JSON body @@ -163,7 +163,7 @@ Resets the configuration settings for [auditing database connections]({{< relref #### Example HTTP request - DELETE /cluster/auditing/db_conns + DELETE /v1/cluster/auditing/db_conns #### Request headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/certificates/_index.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/certificates/_index.md index 370c60c178..9fc05e7ac2 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/certificates/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/certificates/_index.md @@ -37,7 +37,7 @@ Get the cluster's certificates. #### Example HTTP request - GET /cluster/certificates + GET /v1/cluster/certificates #### Request headers @@ -83,7 +83,7 @@ See the [certificates table]({{< relref "/operate/rs/security/certificates" >}}) #### Example HTTP request ```sh -PUT /cluster/update_cert +PUT /v1/cluster/update_cert ``` #### Example JSON body @@ -128,7 +128,7 @@ this endpoint. See the [certificates table]({{< relref "/operate/rs/security/cer #### Example HTTP request - DELETE /cluster/certificates/ + DELETE /v1/cluster/certificates/ #### Request headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/certificates/rotate.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/certificates/rotate.md index 4f8c39b86d..4258608871 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/certificates/rotate.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/certificates/rotate.md @@ -29,7 +29,7 @@ The certificate rotation will be performed on all nodes within the cluster. If #### Example HTTP request - POST /cluster/certificates/rotate + POST /v1/cluster/certificates/rotate #### Request headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/check.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/check.md index 818a8fa1eb..ad01c1b4fa 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/check.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/check.md @@ -44,7 +44,7 @@ Runs the following checks on all cluster nodes: #### Example HTTP request - GET /cluster/check + GET /v1/cluster/check #### Request headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/debuginfo.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/debuginfo.md index f2bc24de2b..21cb82f14d 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/debuginfo.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/debuginfo.md @@ -32,7 +32,7 @@ Downloads a tar file that contains debug info from all nodes and databases. #### Example HTTP request - GET /cluster/debuginfo + GET /v1/cluster/debuginfo ### Response {#get-response} diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/ldap.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/ldap.md index e5ca35979b..7e84809818 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/ldap.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/ldap.md @@ -34,7 +34,7 @@ Get the LDAP configuration. #### Example HTTP request - GET /cluster/ldap + GET /v1/cluster/ldap #### Request headers @@ -87,7 +87,7 @@ Set or update the cluster LDAP configuration. #### Example HTTP request - POST /cluster/ldap + POST /v1/cluster/ldap #### Example JSON body @@ -151,7 +151,7 @@ Clear the LDAP configuration. #### Example HTTP request - DELETE /cluster/ldap + DELETE /v1/cluster/ldap #### Request headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/module-capabilities.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/module-capabilities.md index 28bb897b8d..f6e6932a48 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/module-capabilities.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/module-capabilities.md @@ -32,7 +32,7 @@ List possible Redis module capabilities. #### Example HTTP request - GET /cluster/module-capabilities + GET /v1/cluster/module-capabilities #### Request headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/policy.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/policy.md index 8ba57f59e8..c44efdb722 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/policy.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/policy.md @@ -33,7 +33,7 @@ Gets the cluster's current policy settings. #### Example HTTP request - GET /cluster/policy + GET /v1/cluster/policy #### Request headers @@ -83,7 +83,7 @@ Update cluster policy settings. #### Example HTTP request - PUT /cluster/policy + PUT /v1/cluster/policy #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/services_configuration.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/services_configuration.md index 2338e217d5..be938eb107 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/services_configuration.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/services_configuration.md @@ -33,7 +33,7 @@ Get cluster services settings. #### Example HTTP request - GET /cluster/services_configuration + GET /v1/cluster/services_configuration #### Request headers @@ -82,7 +82,7 @@ Update the cluster services settings. #### Example HTTP request - PUT /cluster/services_configuration + PUT /v1/cluster/services_configuration #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/stats/_index.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/stats/_index.md index a9ecb730a2..02fa17ce85 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/stats/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/stats/_index.md @@ -36,7 +36,7 @@ Get cluster statistics. #### Example HTTP request ```sh -GET /cluster/stats/1?interval=1hour&stime=2014-08-28T10:00:00Z +GET /v1/cluster/stats/1?interval=1hour&stime=2014-08-28T10:00:00Z ``` #### Headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/cluster/stats/last.md b/content/operate/rs/7.4/references/rest-api/requests/cluster/stats/last.md index c25131e354..1306039f3c 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/cluster/stats/last.md +++ b/content/operate/rs/7.4/references/rest-api/requests/cluster/stats/last.md @@ -32,7 +32,7 @@ Get the most recent cluster statistics. #### Example HTTP request - GET /cluster/stats/last?interval=1sec&stime=2015-10-14T06:44:00Z + GET /v1/cluster/stats/last?interval=1sec&stime=2015-10-14T06:44:00Z #### Request headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/crdb_tasks/_index.md b/content/operate/rs/7.4/references/rest-api/requests/crdb_tasks/_index.md index 1257eab6ef..7349dbc387 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/crdb_tasks/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/crdb_tasks/_index.md @@ -29,7 +29,7 @@ The status of a completed task is kept for 500 seconds by default. #### Example HTTP request - GET /crdb_tasks/1 + GET /v1/crdb_tasks/1 #### Request headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/crdbs/_index.md b/content/operate/rs/7.4/references/rest-api/requests/crdbs/_index.md index a0e8cdc652..16a88f3bfb 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/crdbs/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/crdbs/_index.md @@ -34,7 +34,7 @@ Get a list of all Active-Active databases on the cluster. #### Example HTTP request ```sh -GET /crdbs +GET /v1/crdbs ``` #### Headers @@ -68,7 +68,7 @@ Get a specific Active-Active database. #### Example HTTP request ```sh - GET /crdbs/552bbccb-99f3-4142-bd17-93d245f0bc79 + GET /v1/crdbs/552bbccb-99f3-4142-bd17-93d245f0bc79 ``` #### Headers @@ -117,7 +117,7 @@ In order to add or remove instances, use [`POST crdbs/{crdb_guid}/updates` #### Example HTTP request ```sh - PATCH /crdbs/552bbccb-99f3-4142-bd17-93d245f0bc79 + PATCH /v1/crdbs/552bbccb-99f3-4142-bd17-93d245f0bc79 ``` #### Headers @@ -164,7 +164,7 @@ Create a new Active-Active database. #### Example HTTP request ```sh - POST /crdbs + POST /v1/crdbs ``` #### Headers @@ -248,7 +248,7 @@ Delete an Active-Active database. #### Example HTTP request ```sh - DELETE /crdbs/552bbccb-99f3-4142-bd17-93d245f0bc79 + DELETE /v1/crdbs/552bbccb-99f3-4142-bd17-93d245f0bc79 ``` #### Headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/crdbs/flush.md b/content/operate/rs/7.4/references/rest-api/requests/crdbs/flush.md index 1d74fe8f7a..be5086b049 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/crdbs/flush.md +++ b/content/operate/rs/7.4/references/rest-api/requests/crdbs/flush.md @@ -29,7 +29,7 @@ Flush an Active-Active database. #### Example HTTP request ```sh -PUT /crdbs/552bbccb-99f3-4142-bd17-93d245f0bc79/flush +PUT /v1/crdbs/552bbccb-99f3-4142-bd17-93d245f0bc79/flush ``` #### Headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/crdbs/health_report.md b/content/operate/rs/7.4/references/rest-api/requests/crdbs/health_report.md index fa9f21f17e..9ff24fcb6f 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/crdbs/health_report.md +++ b/content/operate/rs/7.4/references/rest-api/requests/crdbs/health_report.md @@ -26,7 +26,7 @@ Get a health report for an Active-Active database. #### Example HTTP request - GET /crdbs/{crdb_guid}/health_report + GET /v1/crdbs/{crdb_guid}/health_report #### URL parameters diff --git a/content/operate/rs/7.4/references/rest-api/requests/crdbs/purge.md b/content/operate/rs/7.4/references/rest-api/requests/crdbs/purge.md index 49340ee3f8..0adeb40fa0 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/crdbs/purge.md +++ b/content/operate/rs/7.4/references/rest-api/requests/crdbs/purge.md @@ -35,7 +35,7 @@ removed instance). #### Example HTTP request - PUT /crdbs/1/purge + PUT /v1/crdbs/1/purge #### URL parameters diff --git a/content/operate/rs/7.4/references/rest-api/requests/crdbs/updates.md b/content/operate/rs/7.4/references/rest-api/requests/crdbs/updates.md index 6039180413..8e1e57203c 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/crdbs/updates.md +++ b/content/operate/rs/7.4/references/rest-api/requests/crdbs/updates.md @@ -36,7 +36,7 @@ When you update db_config, it changes the configuration of the database that you #### Example HTTP request - POST /crdbs/1/updates + POST /v1/crdbs/1/updates #### Request headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/debuginfo/all/_index.md b/content/operate/rs/7.4/references/rest-api/requests/debuginfo/all/_index.md index c5349e8574..5134d65ea2 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/debuginfo/all/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/debuginfo/all/_index.md @@ -37,7 +37,7 @@ Downloads a tar file that contains debug info from all nodes. #### Example HTTP request - GET /debuginfo/all + GET /v1/debuginfo/all ### Response {#get-all-response} diff --git a/content/operate/rs/7.4/references/rest-api/requests/debuginfo/all/bdb.md b/content/operate/rs/7.4/references/rest-api/requests/debuginfo/all/bdb.md index 2485492041..ee5ef1bbba 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/debuginfo/all/bdb.md +++ b/content/operate/rs/7.4/references/rest-api/requests/debuginfo/all/bdb.md @@ -36,7 +36,7 @@ Downloads a tar file that contains debug info for the specified database (`bdb_u #### Example HTTP request - GET /debuginfo/all/bdb/1 + GET /v1/debuginfo/all/bdb/1 ### Response {#get-all-response} diff --git a/content/operate/rs/7.4/references/rest-api/requests/debuginfo/node/_index.md b/content/operate/rs/7.4/references/rest-api/requests/debuginfo/node/_index.md index a007d4292c..25f3bc1853 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/debuginfo/node/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/debuginfo/node/_index.md @@ -37,7 +37,7 @@ Downloads a tar file that contains debug info for the current node. #### Example HTTP request - GET /debuginfo/node + GET /v1/debuginfo/node ### Response {#get-response} diff --git a/content/operate/rs/7.4/references/rest-api/requests/debuginfo/node/bdb.md b/content/operate/rs/7.4/references/rest-api/requests/debuginfo/node/bdb.md index a15b001339..dff4e5117e 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/debuginfo/node/bdb.md +++ b/content/operate/rs/7.4/references/rest-api/requests/debuginfo/node/bdb.md @@ -36,7 +36,7 @@ Downloads a tar file that contains debug info for the specified database (`bdb_u #### Example HTTP request - GET /debuginfo/node/bdb/1 + GET /v1/debuginfo/node/bdb/1 ### Response {#get-response} diff --git a/content/operate/rs/7.4/references/rest-api/requests/endpoints-stats/_index.md b/content/operate/rs/7.4/references/rest-api/requests/endpoints-stats/_index.md index 0da4d0dd07..3afee71037 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/endpoints-stats/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/endpoints-stats/_index.md @@ -38,7 +38,7 @@ compatability. #### Example HTTP request - GET /endpoints/stats?interval=1hour&stime=2014-08-28T10:00:00Z + GET /v1/endpoints/stats?interval=1hour&stime=2014-08-28T10:00:00Z #### Request headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/jsonschema/_index.md b/content/operate/rs/7.4/references/rest-api/requests/jsonschema/_index.md index 38611508c7..286e1dfc5f 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/jsonschema/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/jsonschema/_index.md @@ -27,7 +27,7 @@ Get the JSON schema of various [Redis Enterprise REST API objects]({{< relref "/ #### Example HTTP request - GET /jsonschema?object=bdb + GET /v1/jsonschema?object=bdb #### Request headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/ldap_mappings/_index.md b/content/operate/rs/7.4/references/rest-api/requests/ldap_mappings/_index.md index 1e95388f58..5b395b4da2 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/ldap_mappings/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/ldap_mappings/_index.md @@ -37,7 +37,7 @@ Get all LDAP mappings. #### Example HTTP request - GET /ldap_mappings + GET /v1/ldap_mappings #### Request headers @@ -89,7 +89,7 @@ Get a specific LDAP mapping. #### Example HTTP request - GET /ldap_mappings/1 + GET /v1/ldap_mappings/1 #### Request headers @@ -157,7 +157,7 @@ Update an existing ldap_mapping object. #### Example HTTP request - PUT /ldap_mappings/17 + PUT /v1/ldap_mappings/17 #### Example JSON body @@ -239,7 +239,7 @@ Create a new LDAP mapping. #### Example HTTP request - POST /ldap_mappings + POST /v1/ldap_mappings #### Example JSON body @@ -315,7 +315,7 @@ Delete an LDAP mapping object. #### Example HTTP request - DELETE /ldap_mappings/1 + DELETE /v1/ldap_mappings/1 #### Request headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/license/_index.md b/content/operate/rs/7.4/references/rest-api/requests/license/_index.md index 51c8fc79d4..69db16a811 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/license/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/license/_index.md @@ -35,7 +35,7 @@ and supported features. #### Example HTTP request - GET /license + GET /v1/license #### Request headers @@ -112,7 +112,7 @@ The request must be a JSON object with a single key named "license". #### Example HTTP request - PUT /license + PUT /v1/license #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/logs/_index.md b/content/operate/rs/7.4/references/rest-api/requests/logs/_index.md index dba6182018..da2aa5f88f 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/logs/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/logs/_index.md @@ -33,7 +33,7 @@ Get cluster events log. #### Example HTTP request - GET /logs?order=desc + GET /v1/logs?order=desc #### Request headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/modules/_index.md b/content/operate/rs/7.4/references/rest-api/requests/modules/_index.md index bfa3aaa18e..6a4dd786f6 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/modules/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/modules/_index.md @@ -41,7 +41,7 @@ List available modules, i.e. modules stored within the CCS. #### Example HTTP request ```sh -GET /modules +GET /v1/modules ``` #### Headers @@ -80,7 +80,7 @@ Get specific available modules, i.e. modules stored within the CCS. #### Example HTTP request ```sh -GET /modules/1 +GET /v1/modules/1 ``` #### Headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/modules/config.md b/content/operate/rs/7.4/references/rest-api/requests/modules/config.md index 46817e89ff..608f5075d3 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/modules/config.md +++ b/content/operate/rs/7.4/references/rest-api/requests/modules/config.md @@ -32,7 +32,7 @@ Use the module runtime configuration command (if defined) to configure new argum #### Example HTTP request - POST /modules/config/bdb/1 + POST /v1/modules/config/bdb/1 #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/modules/upgrade.md b/content/operate/rs/7.4/references/rest-api/requests/modules/upgrade.md index b7019af77f..6211ac9f25 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/modules/upgrade.md +++ b/content/operate/rs/7.4/references/rest-api/requests/modules/upgrade.md @@ -32,7 +32,7 @@ Upgrades the module version on a specific database. #### Example HTTP request - POST /modules/upgrade/bdb/1 + POST /v1/modules/upgrade/bdb/1 #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/nodes/_index.md b/content/operate/rs/7.4/references/rest-api/requests/nodes/_index.md index ec821addaf..0f6212e54c 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/nodes/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/nodes/_index.md @@ -38,7 +38,7 @@ Get all cluster nodes. #### Example HTTP request ```sh -GET /nodes +GET /v1/nodes ``` #### Headers @@ -122,7 +122,7 @@ Get a single cluster node. #### Example HTTP request ```sh -GET /nodes/1 +GET /v1/nodes/1 ``` #### Headers @@ -192,7 +192,7 @@ You can only update the `addr` attribute for offline nodes. Otherwise, the reque #### Example HTTP request ```sh -PUT /nodes/1 +PUT /v1/nodes/1 ``` #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/nodes/actions.md b/content/operate/rs/7.4/references/rest-api/requests/nodes/actions.md index e86b06281f..f5f463a298 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/nodes/actions.md +++ b/content/operate/rs/7.4/references/rest-api/requests/nodes/actions.md @@ -40,7 +40,7 @@ actions on all nodes. #### Example HTTP request ```sh -GET /nodes/actions +GET /v1/nodes/actions ``` #### Request headers @@ -79,7 +79,7 @@ Get the status of all actions on a specific node. #### Example HTTP request ```sh -GET /nodes/1/actions +GET /v1/nodes/1/actions ``` #### Request headers @@ -143,7 +143,7 @@ Get the status of a currently executing, queued, or completed action on a specif #### Example HTTP request ```sh -GET /nodes/1/actions/remove +GET /v1/nodes/1/actions/remove ``` #### Headers @@ -198,7 +198,7 @@ removed as soon as the new one is submitted. #### Example HTTP request ```sh -POST /nodes/1/actions/remove +POST /v1/nodes/1/actions/remove ``` #### Headers @@ -330,7 +330,7 @@ previously executed and completed action. #### Example HTTP request ```sh -DELETE /nodes/1/actions/remove +DELETE /v1/nodes/1/actions/remove ``` #### Headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/nodes/alerts.md b/content/operate/rs/7.4/references/rest-api/requests/nodes/alerts.md index c06ec879dd..896e0775b7 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/nodes/alerts.md +++ b/content/operate/rs/7.4/references/rest-api/requests/nodes/alerts.md @@ -34,7 +34,7 @@ Get all alert states for all nodes. #### Example HTTP request - GET /nodes/alerts + GET /v1/nodes/alerts #### Request headers @@ -97,7 +97,7 @@ Get all alert states for a node. #### Example HTTP request - GET /nodes/alerts/1 + GET /v1/nodes/alerts/1 #### Request headers @@ -160,7 +160,7 @@ Get a node alert state. #### Example HTTP request - GET /nodes/alerts/1/node_cpu_utilization + GET /v1/nodes/alerts/1/node_cpu_utilization #### Request headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/nodes/check.md b/content/operate/rs/7.4/references/rest-api/requests/nodes/check.md index 4c334a2e61..da6a171acd 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/nodes/check.md +++ b/content/operate/rs/7.4/references/rest-api/requests/nodes/check.md @@ -44,7 +44,7 @@ Runs the following checks on a cluster node: #### Example HTTP request - GET /nodes/check/1 + GET /v1/nodes/check/1 #### Request headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/nodes/debuginfo.md b/content/operate/rs/7.4/references/rest-api/requests/nodes/debuginfo.md index 522e8e54ee..86b130aeae 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/nodes/debuginfo.md +++ b/content/operate/rs/7.4/references/rest-api/requests/nodes/debuginfo.md @@ -33,7 +33,7 @@ Downloads a tar file that contains debug info from all nodes. #### Example HTTP request - GET /nodes/debuginfo + GET /v1/nodes/debuginfo ### Response {#get-all-response} @@ -70,7 +70,7 @@ Downloads a tar file that contains debug info from a specific node. #### Example HTTP request - GET /nodes/1/debuginfo + GET /v1/nodes/1/debuginfo ### Response {#get-response} diff --git a/content/operate/rs/7.4/references/rest-api/requests/nodes/snapshots.md b/content/operate/rs/7.4/references/rest-api/requests/nodes/snapshots.md index bcaef73b88..f2b7d97a1f 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/nodes/snapshots.md +++ b/content/operate/rs/7.4/references/rest-api/requests/nodes/snapshots.md @@ -36,7 +36,7 @@ Get all cluster node snapshots of the specified node. #### Example HTTP request ```sh -GET /nodes/1/snapshots +GET /v1/nodes/1/snapshots ``` #### Headers @@ -99,7 +99,7 @@ Delete a cluster node snapshot. Snapshots created by maintenance mode are not de #### Example HTTP request ```sh -DELETE /nodes/1/snapshots/nightly_snapshot_19 +DELETE /v1/nodes/1/snapshots/nightly_snapshot_19 ``` #### Request headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/nodes/stats/_index.md b/content/operate/rs/7.4/references/rest-api/requests/nodes/stats/_index.md index 7001710b75..969e5c2b2a 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/nodes/stats/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/nodes/stats/_index.md @@ -37,7 +37,7 @@ Get statistics for all nodes. #### Example HTTP request ```sh -GET /nodes/stats?interval=1hour&stime=2014-08-28T10:00:00Z +GET /v1/nodes/stats?interval=1hour&stime=2014-08-28T10:00:00Z ``` #### Request headers @@ -150,7 +150,7 @@ Get statistics for a node. #### Example HTTP request ```sh -GET /nodes/stats/1?interval=1hour&stime=2014-08-28T10:00:00Z +GET /v1/nodes/stats/1?interval=1hour&stime=2014-08-28T10:00:00Z ``` #### Request headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/nodes/stats/last.md b/content/operate/rs/7.4/references/rest-api/requests/nodes/stats/last.md index 87960c427e..e54cde5b1e 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/nodes/stats/last.md +++ b/content/operate/rs/7.4/references/rest-api/requests/nodes/stats/last.md @@ -36,7 +36,7 @@ Get latest statistics for all nodes. #### Example HTTP request ```sh -GET /nodes/stats/last?interval=1sec&stime=2015-10-14T06:29:43Z +GET /v1/nodes/stats/last?interval=1sec&stime=2015-10-14T06:29:43Z ``` @@ -116,7 +116,7 @@ Get the latest statistics of a node. #### Example HTTP request ```sh -GET /nodes/stats/last/1?interval=1sec&stime=2015-10-13T09:01:54Z +GET /v1/nodes/stats/last/1?interval=1sec&stime=2015-10-13T09:01:54Z ``` diff --git a/content/operate/rs/7.4/references/rest-api/requests/nodes/status.md b/content/operate/rs/7.4/references/rest-api/requests/nodes/status.md index 221304eec0..a0e38802b0 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/nodes/status.md +++ b/content/operate/rs/7.4/references/rest-api/requests/nodes/status.md @@ -38,7 +38,7 @@ Gets the status of all nodes. Includes each node's hostname and role in the clus #### Example HTTP request - GET /nodes/status + GET /v1/nodes/status #### Request headers @@ -117,7 +117,7 @@ Gets the status of a node. Includes the node's hostname and role in the cluster: #### Example HTTP request - GET /nodes/1/status + GET /v1/nodes/1/status #### Request headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/ocsp/_index.md b/content/operate/rs/7.4/references/rest-api/requests/ocsp/_index.md index 2c5bfdfe78..8a0a91cb45 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/ocsp/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/ocsp/_index.md @@ -34,7 +34,7 @@ Gets the cluster's OCSP configuration. #### Example HTTP request - GET /ocsp + GET /v1/ocsp #### Request headers @@ -92,7 +92,7 @@ Updates the cluster's OCSP configuration. #### Example HTTP request - PUT /ocsp + PUT /v1/ocsp #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/ocsp/status.md b/content/operate/rs/7.4/references/rest-api/requests/ocsp/status.md index 498b98deaa..395473f17b 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/ocsp/status.md +++ b/content/operate/rs/7.4/references/rest-api/requests/ocsp/status.md @@ -32,7 +32,7 @@ Gets the latest cached status of the proxy certificate’s OCSP response. #### Example HTTP request - GET /ocsp/status + GET /v1/ocsp/status #### Request headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/ocsp/test.md b/content/operate/rs/7.4/references/rest-api/requests/ocsp/test.md index 7b6af74584..d362535b38 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/ocsp/test.md +++ b/content/operate/rs/7.4/references/rest-api/requests/ocsp/test.md @@ -32,7 +32,7 @@ Queries the OCSP server for the proxy certificate’s latest status and returns #### Example HTTP request - POST /ocsp/test + POST /v1/ocsp/test #### Request headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/proxies/_index.md b/content/operate/rs/7.4/references/rest-api/requests/proxies/_index.md index 91dfd63bfe..728b46f203 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/proxies/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/proxies/_index.md @@ -39,7 +39,7 @@ Get all the proxies in the cluster. #### Example HTTP request ```sh -GET /proxies +GET /v1/proxies ``` #### Headers @@ -110,7 +110,7 @@ Get a single proxy's info. #### Example HTTP request ```sh -GET /proxies/1 +GET /v1/proxies/1 ``` #### Headers @@ -185,7 +185,7 @@ However, if `allow_restart` is `false`, such changes only take effect after the #### Example HTTP request ```sh -PUT /proxies/1 +PUT /v1/proxies/1 ``` #### Example JSON body @@ -254,7 +254,7 @@ However, if `allow_restart` is `false`, such changes only take effect after the #### Example HTTP request ```sh -PUT /proxies +PUT /v1/proxies ``` #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/redis_acls/_index.md b/content/operate/rs/7.4/references/rest-api/requests/redis_acls/_index.md index e923651385..8c757d7a36 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/redis_acls/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/redis_acls/_index.md @@ -40,7 +40,7 @@ Get all Redis ACL objects. #### Example HTTP request ```sh -GET /redis_acls +GET /v1/redis_acls ``` #### Headers @@ -107,7 +107,7 @@ Get a single Redis ACL object. #### Example HTTP request ```sh -GET /redis_acls/1 +GET /v1/redis_acls/1 ``` #### Headers @@ -166,7 +166,7 @@ Update an existing Redis ACL object. #### Example HTTP request ```sh -PUT /redis_acls/17 +PUT /v1/redis_acls/17 ``` #### Example JSON body @@ -240,7 +240,7 @@ Create a new Redis ACL object. #### Example HTTP request ```sh -POST /redis_acls +POST /v1/redis_acls ``` #### Example JSON body @@ -351,7 +351,7 @@ Delete a Redis ACL object. #### Example HTTP request ```sh -DELETE /redis_acls/1 +DELETE /v1/redis_acls/1 ``` #### Headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/roles/_index.md b/content/operate/rs/7.4/references/rest-api/requests/roles/_index.md index c9905b1845..abca747a6c 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/roles/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/roles/_index.md @@ -40,7 +40,7 @@ Get all roles' details. #### Example HTTP request ```sh -GET /roles +GET /v1/roles ``` #### Headers @@ -122,7 +122,7 @@ Get the details of a single role. #### Example HTTP request ```sh -GET /roles/1 +GET /v1/roles/1 ``` @@ -182,7 +182,7 @@ Update an existing role's details. #### Example HTTP request ```sh -PUT /roles/17 +PUT /v1/roles/17 ``` #### Example JSON body @@ -257,7 +257,7 @@ Create a new role. #### Example HTTP request ```sh -POST /roles +POST /v1/roles ``` #### Example JSON body @@ -367,7 +367,7 @@ Delete a role object. #### Example HTTP request ```sh -DELETE /roles/1 +DELETE /v1/roles/1 ``` #### Headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/shards/_index.md b/content/operate/rs/7.4/references/rest-api/requests/shards/_index.md index 4e3edd67cc..a852fed836 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/shards/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/shards/_index.md @@ -28,7 +28,7 @@ Get information about all shards in the cluster. #### Example HTTP request - GET /shards?extra_info_keys=used_memory_rss&extra_info_keys=connected_clients + GET /v1/shards?extra_info_keys=used_memory_rss&extra_info_keys=connected_clients #### Request headers @@ -92,7 +92,7 @@ Gets information about a single shard. #### Example HTTP request - GET /shards/1?extra_info_keys=used_memory_rss&extra_info_keys=connected_clients + GET /v1/shards/1?extra_info_keys=used_memory_rss&extra_info_keys=connected_clients #### Request headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/shards/actions/migrate.md b/content/operate/rs/7.4/references/rest-api/requests/shards/actions/migrate.md index 41dc4b26b3..32530c0218 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/shards/actions/migrate.md +++ b/content/operate/rs/7.4/references/rest-api/requests/shards/actions/migrate.md @@ -35,7 +35,7 @@ For more information about shard migration use cases and considerations, see [Mi #### Example HTTP request - POST /shards/actions/migrate + POST /v1/shards/actions/migrate #### Example JSON body @@ -110,7 +110,7 @@ For more information about shard migration use cases and considerations, see [Mi #### Example HTTP request - POST /shards/1/actions/migrate + POST /v1/shards/1/actions/migrate #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/shards/stats/_index.md b/content/operate/rs/7.4/references/rest-api/requests/shards/stats/_index.md index 7769304ef6..66d847d994 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/shards/stats/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/shards/stats/_index.md @@ -35,7 +35,7 @@ Get statistics for all shards. #### Example HTTP request - GET /shards/stats?interval=1hour&stime=2014-08-28T10:00:00Z + GET /v1/shards/stats?interval=1hour&stime=2014-08-28T10:00:00Z #### Request headers @@ -153,7 +153,7 @@ Get statistics for a specific shard. #### Example HTTP request - GET /shards/stats/1?interval=1hour&stime=2014-08-28T10:00:00Z + GET /v1/shards/stats/1?interval=1hour&stime=2014-08-28T10:00:00Z #### Request headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/shards/stats/last.md b/content/operate/rs/7.4/references/rest-api/requests/shards/stats/last.md index e47381f23d..5a833a42f7 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/shards/stats/last.md +++ b/content/operate/rs/7.4/references/rest-api/requests/shards/stats/last.md @@ -34,7 +34,7 @@ Get most recent statistics for all shards. #### Example HTTP request - GET /shards/stats/last?interval=1sec&stime=015-05-27T08:27:35Z + GET /v1/shards/stats/last?interval=1sec&stime=015-05-27T08:27:35Z #### Request headers @@ -122,7 +122,7 @@ Get most recent statistics for a specific shard. #### Example HTTP request - GET /shards/stats/last/1?interval=1sec&stime=2015-05-28T08:27:35Z + GET /v1/shards/stats/last/1?interval=1sec&stime=2015-05-28T08:27:35Z #### Request headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/suffix/_index.md b/content/operate/rs/7.4/references/rest-api/requests/suffix/_index.md index 946929dc72..337cab14dc 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/suffix/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/suffix/_index.md @@ -27,7 +27,7 @@ Get a single DNS suffix. #### Example HTTP request - GET /suffix/cluster.fqdn + GET /v1/suffix/cluster.fqdn #### Request headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/suffixes/_index.md b/content/operate/rs/7.4/references/rest-api/requests/suffixes/_index.md index ddffe2a774..c81c8b3c18 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/suffixes/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/suffixes/_index.md @@ -27,7 +27,7 @@ Get all DNS suffixes in the cluster. #### Example HTTP request - GET /suffixes + GET /v1/suffixes #### Request headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/users/_index.md b/content/operate/rs/7.4/references/rest-api/requests/users/_index.md index 1d8f7e5205..270d7c878e 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/users/_index.md +++ b/content/operate/rs/7.4/references/rest-api/requests/users/_index.md @@ -40,7 +40,7 @@ Get a list of all users. #### Example HTTP request ```sh -GET /users +GET /v1/users ``` #### Headers @@ -107,7 +107,7 @@ Get a single user's details. #### Example HTTP request ```sh -GET /users/1 +GET /v1/users/1 ``` #### Headers @@ -172,7 +172,7 @@ Any user can change their own name, password, or alert preferences. #### Example HTTP request ```sh -PUT /users/1 +PUT /v1/users/1 ``` #### Example JSON body @@ -265,7 +265,7 @@ Create a new user. #### Example HTTP request ```sh -POST /users +POST /v1/users ``` #### Headers @@ -413,7 +413,7 @@ Delete a user. #### Example HTTP request ```sh -DELETE /users/1 +DELETE /v1/users/1 ``` #### Headers diff --git a/content/operate/rs/7.4/references/rest-api/requests/users/authorize.md b/content/operate/rs/7.4/references/rest-api/requests/users/authorize.md index 74dd28df82..869ff0ca08 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/users/authorize.md +++ b/content/operate/rs/7.4/references/rest-api/requests/users/authorize.md @@ -26,7 +26,7 @@ Generate a JSON Web Token (JWT) for a user to use as authorization to access the #### Example HTTP request - POST /users/authorize + POST /v1/users/authorize #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/users/password.md b/content/operate/rs/7.4/references/rest-api/requests/users/password.md index 983f6b95ac..709ddb9878 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/users/password.md +++ b/content/operate/rs/7.4/references/rest-api/requests/users/password.md @@ -28,7 +28,7 @@ Reset the password list of an internal user to include a new password. #### Example HTTP request - PUT /users/password + PUT /v1/users/password #### Example JSON body @@ -90,7 +90,7 @@ Add a new password to an internal user's passwords list. #### Example HTTP request - POST /users/password + POST /v1/users/password #### Example JSON body @@ -151,7 +151,7 @@ Delete a password from an internal user's passwords list. #### Example HTTP request - DELETE /users/password + DELETE /v1/users/password #### Example JSON body diff --git a/content/operate/rs/7.4/references/rest-api/requests/users/refresh_jwt.md b/content/operate/rs/7.4/references/rest-api/requests/users/refresh_jwt.md index 8d53d21ea1..b2a6fb3c7e 100644 --- a/content/operate/rs/7.4/references/rest-api/requests/users/refresh_jwt.md +++ b/content/operate/rs/7.4/references/rest-api/requests/users/refresh_jwt.md @@ -28,7 +28,7 @@ Takes a valid token and returns the new token generated by the request. #### Example HTTP request - POST /users/refresh_jwt + POST /v1/users/refresh_jwt #### Request headers diff --git a/content/operate/rs/references/rest-api/objects/bdb/_index.md b/content/operate/rs/references/rest-api/objects/bdb/_index.md index d2bc5482fa..dfc737ec99 100644 --- a/content/operate/rs/references/rest-api/objects/bdb/_index.md +++ b/content/operate/rs/references/rest-api/objects/bdb/_index.md @@ -64,7 +64,7 @@ An API object that represents a managed database in the cluster. | created_time | string; The date and time the database was created (read-only) | | data_internode_encryption | boolean; Should the data plane internode communication for this database be encrypted | | data_persistence | Database on-disk persistence policy. For snapshot persistence, a [snapshot_policy]({{< relref "/operate/rs/references/rest-api/objects/bdb/snapshot_policy" >}}) must be provided
Values:
**'disabled'**
'snapshot'
'aof' | -| dataset_import_sources | [complex object]({{< relref "/operate/rs/references/rest-api/objects/bdb/dataset_import_sources" >}}); Array of source file location description objects to import from when performing an import action. This is write-only and cannot be read after set.
Call GET /jsonschema to retrieve the object's structure. | +| dataset_import_sources | [complex object]({{< relref "/operate/rs/references/rest-api/objects/bdb/dataset_import_sources" >}}); Array of source file location description objects to import from when performing an import action. This is write-only and cannot be read after set.
Call `GET /v1/jsonschema` to retrieve the object's structure. | | db_conns_auditing | boolean; Enables/deactivates [database connection auditing]({{< relref "/operate/rs/security/audit-events" >}}) | | default_user | boolean (default: true); Allow/disallow a default user to connect | | disabled_commands | string (default: ); Redis commands which are disabled in db | diff --git a/content/operate/rs/references/rest-api/permissions.md b/content/operate/rs/references/rest-api/permissions.md index bbaa2a9dda..dfa8a690a2 100644 --- a/content/operate/rs/references/rest-api/permissions.md +++ b/content/operate/rs/references/rest-api/permissions.md @@ -13,7 +13,7 @@ weight: 60 Some Redis Enterprise [REST API requests]({{< relref "/operate/rs/references/rest-api/requests" >}}) may require the user to have specific permissions. -Administrators can assign a predefined role to a user with the [Cluster Manager UI]({{< relref "/operate/rs/security/access-control/create-users" >}}) or a [
`PUT /users/{uid}` API request]({{< relref "/operate/rs/references/rest-api/requests/users#put-user" >}}) to grant necessary permissions to them. +Administrators can assign a predefined role to a user with the [Cluster Manager UI]({{< relref "/operate/rs/security/access-control/create-users" >}}) or a [`PUT /v1/users/{uid}` API request]({{< relref "/operate/rs/references/rest-api/requests/users#put-user" >}}) to grant necessary permissions to them. ## Roles diff --git a/content/operate/rs/references/rest-api/requests/actions/_index.md b/content/operate/rs/references/rest-api/requests/actions/_index.md index 5bec2f6375..a1a3e81f26 100644 --- a/content/operate/rs/references/rest-api/requests/actions/_index.md +++ b/content/operate/rs/references/rest-api/requests/actions/_index.md @@ -36,7 +36,7 @@ Get the status of all actions (executing, queued, or completed) on all entities #### Example HTTP request ``` -GET /actions +GET /v1/actions ``` ### Response {#get-all-response} @@ -106,7 +106,7 @@ Get the status of a currently executing, queued, or completed action. #### Example HTTP request ``` -GET /actions/{uid} +GET /v1/actions/{uid} ``` #### URL parameters diff --git a/content/operate/rs/references/rest-api/requests/actions/bdb.md b/content/operate/rs/references/rest-api/requests/actions/bdb.md index e0e9757e2c..ac11253ae8 100644 --- a/content/operate/rs/references/rest-api/requests/actions/bdb.md +++ b/content/operate/rs/references/rest-api/requests/actions/bdb.md @@ -34,7 +34,7 @@ Get the status of all currently executing, pending, or completed state-machine-r #### Example HTTP request ``` -GET /actions/bdb/1 +GET /v1/actions/bdb/1 ``` #### URL parameters diff --git a/content/operate/rs/references/rest-api/requests/bdbs/_index.md b/content/operate/rs/references/rest-api/requests/bdbs/_index.md index e90102c7c1..7db4438e5a 100644 --- a/content/operate/rs/references/rest-api/requests/bdbs/_index.md +++ b/content/operate/rs/references/rest-api/requests/bdbs/_index.md @@ -131,7 +131,7 @@ Get a single database. #### Example HTTP request ```sh -GET /bdbs/1 +GET /v1/bdbs/1 ``` #### Headers @@ -200,7 +200,7 @@ To track this request's progress, poll the [`/actions/` endpoint]({{ #### Example HTTP request ```sh -PUT /bdbs/1 +PUT /v1/bdbs/1 ``` #### Headers @@ -308,7 +308,7 @@ If called with the `dry_run` URL query string, the function will validate the [B #### Example HTTP request ```sh -PUT /bdbs/1/reset_admin_pass +PUT /v1/bdbs/1/reset_admin_pass ``` The above request resets the admin password after updating the database. @@ -425,7 +425,7 @@ The cluster will use default configuration for any missing database field. The c #### Example HTTP request ```sh -POST /bdbs +POST /v1/bdbs ``` #### Headers @@ -627,7 +627,7 @@ Delete an active database. #### Example HTTP request ```sh -DELETE /bdbs/1 +DELETE /v1/bdbs/1 ``` #### Headers diff --git a/content/operate/rs/references/rest-api/requests/bdbs/actions/backup_reset_status.md b/content/operate/rs/references/rest-api/requests/bdbs/actions/backup_reset_status.md index 0b56e0ed81..39a5806fef 100644 --- a/content/operate/rs/references/rest-api/requests/bdbs/actions/backup_reset_status.md +++ b/content/operate/rs/references/rest-api/requests/bdbs/actions/backup_reset_status.md @@ -34,7 +34,7 @@ Resets the database's `backup_status` to idle if a backup is not in progress and #### Example HTTP request ```sh -PUT /bdbs/1/actions/backup_reset_status +PUT /v1/bdbs/1/actions/backup_reset_status ``` #### Headers diff --git a/content/operate/rs/references/rest-api/requests/bdbs/actions/export.md b/content/operate/rs/references/rest-api/requests/bdbs/actions/export.md index b062feb3e7..c407aeb558 100644 --- a/content/operate/rs/references/rest-api/requests/bdbs/actions/export.md +++ b/content/operate/rs/references/rest-api/requests/bdbs/actions/export.md @@ -34,7 +34,7 @@ Initiate a database export. #### Example HTTP request ```sh -POST /bdbs/1/actions/export +POST /v1/bdbs/1/actions/export ``` #### Headers @@ -58,7 +58,7 @@ The request body should contain a JSON object with the following export paramete | Field | Type | Description | |-------|------|-------------| -| export_location | [backup_location/export_location]({{< relref "/operate/rs/references/rest-api/objects/bdb/backup_location" >}}) object | Details for the export destination. Call [`GET /jsonschema`]({{< relref "/operate/rs/references/rest-api/requests/jsonschema#get-jsonschema" >}}) on the bdb object and review the `backup_location` field to retrieve the object's structure. | +| export_location | [backup_location/export_location]({{< relref "/operate/rs/references/rest-api/objects/bdb/backup_location" >}}) object | Details for the export destination. Call [`GET /v1/jsonschema`]({{< relref "/operate/rs/references/rest-api/requests/jsonschema#get-jsonschema" >}}) on the bdb object and review the `backup_location` field to retrieve the object's structure. | | email_notification | boolean | Enable/disable an email notification on export failure/ completion. (optional) | ##### Example JSON body diff --git a/content/operate/rs/references/rest-api/requests/bdbs/actions/export_reset_status.md b/content/operate/rs/references/rest-api/requests/bdbs/actions/export_reset_status.md index aa2c1a928a..c024b8a0a3 100644 --- a/content/operate/rs/references/rest-api/requests/bdbs/actions/export_reset_status.md +++ b/content/operate/rs/references/rest-api/requests/bdbs/actions/export_reset_status.md @@ -32,7 +32,7 @@ Resets the database's `export_status` to idle if an export is not in progress an #### Example HTTP request ```sh -PUT /bdbs/1/actions/export_reset_status +PUT /v1/bdbs/1/actions/export_reset_status ``` #### Request headers diff --git a/content/operate/rs/references/rest-api/requests/bdbs/actions/import.md b/content/operate/rs/references/rest-api/requests/bdbs/actions/import.md index 66e7ff6976..4d061ee6a4 100644 --- a/content/operate/rs/references/rest-api/requests/bdbs/actions/import.md +++ b/content/operate/rs/references/rest-api/requests/bdbs/actions/import.md @@ -34,7 +34,7 @@ Initiate a manual import process. #### Example HTTP request ```sh -POST /bdbs/1/actions/import +POST /v1/bdbs/1/actions/import ``` #### Headers @@ -57,7 +57,7 @@ The request _may_ contain a subset of the [BDB JSON object]({{< relref "/operate | Field | Type | Description | |-------|------|-------------| -| dataset_import_sources | array of [dataset_import_sources]({{< relref "/operate/rs/references/rest-api/objects/bdb/dataset_import_sources" >}}) objects | Details for the import sources. Call [`GET /jsonschema`]({{< relref "/operate/rs/references/rest-api/requests/jsonschema#get-jsonschema" >}}) on the bdb object and review the `dataset_import_sources` field to retrieve the object's structure. | +| dataset_import_sources | array of [dataset_import_sources]({{< relref "/operate/rs/references/rest-api/objects/bdb/dataset_import_sources" >}}) objects | Details for the import sources. Call [`GET /v1/jsonschema`]({{< relref "/operate/rs/references/rest-api/requests/jsonschema#get-jsonschema" >}}) on the bdb object and review the `dataset_import_sources` field to retrieve the object's structure. | | email_notification | boolean | Enable/disable an email notification on import failure/ completion. (optional) | {{}} diff --git a/content/operate/rs/references/rest-api/requests/bdbs/actions/import_reset_status.md b/content/operate/rs/references/rest-api/requests/bdbs/actions/import_reset_status.md index e5d0451b70..18f506a62d 100644 --- a/content/operate/rs/references/rest-api/requests/bdbs/actions/import_reset_status.md +++ b/content/operate/rs/references/rest-api/requests/bdbs/actions/import_reset_status.md @@ -32,7 +32,7 @@ Reset the database’s `import_status` to idle if a backup is not in progress an #### Example HTTP request ```sh -PUT /bdbs/1/actions/import_reset_status +PUT /v1/bdbs/1/actions/import_reset_status ``` diff --git a/content/operate/rs/references/rest-api/requests/bdbs/actions/rebalance.md b/content/operate/rs/references/rest-api/requests/bdbs/actions/rebalance.md index e90a7ec3fb..dfded214e6 100644 --- a/content/operate/rs/references/rest-api/requests/bdbs/actions/rebalance.md +++ b/content/operate/rs/references/rest-api/requests/bdbs/actions/rebalance.md @@ -34,13 +34,13 @@ Distributes the database's shards across nodes based on the database's shard pla #### Example HTTP request ```sh -PUT /bdbs/1/actions/rebalance +PUT /v1/bdbs/1/actions/rebalance ``` Dry-run example: ```sh -PUT /bdbs/1/actions/rebalance?only_failovers=true&dry_run=true +PUT /v1/bdbs/1/actions/rebalance?only_failovers=true&dry_run=true ``` #### URL parameters diff --git a/content/operate/rs/references/rest-api/requests/bdbs/actions/recover.md b/content/operate/rs/references/rest-api/requests/bdbs/actions/recover.md index 0f7a6e64b3..b88afc5ec6 100644 --- a/content/operate/rs/references/rest-api/requests/bdbs/actions/recover.md +++ b/content/operate/rs/references/rest-api/requests/bdbs/actions/recover.md @@ -35,7 +35,7 @@ Fetches the recovery plan for a database. The recovery plan provides information #### Example HTTP request ```sh -GET /bdbs/1/actions/recover +GET /v1/bdbs/1/actions/recover ``` #### URL parameters @@ -112,7 +112,7 @@ If the request body is empty, the database will be recovered automatically: #### Example HTTP request ```sh -POST /bdbs/1/actions/recover +POST /v1/bdbs/1/actions/recover ``` #### Example request body diff --git a/content/operate/rs/references/rest-api/requests/bdbs/actions/resume_traffic.md b/content/operate/rs/references/rest-api/requests/bdbs/actions/resume_traffic.md index a1d42001d5..7bc42d13bf 100644 --- a/content/operate/rs/references/rest-api/requests/bdbs/actions/resume_traffic.md +++ b/content/operate/rs/references/rest-api/requests/bdbs/actions/resume_traffic.md @@ -36,7 +36,7 @@ Use this action to resume read and write traffic on a database, where traffic wa #### Example HTTP request ```sh -POST /bdbs/1/actions/resume_traffic +POST /v1/bdbs/1/actions/resume_traffic ``` #### URL parameters diff --git a/content/operate/rs/references/rest-api/requests/bdbs/actions/stop_traffic.md b/content/operate/rs/references/rest-api/requests/bdbs/actions/stop_traffic.md index d06fa0fe8e..704c949a02 100644 --- a/content/operate/rs/references/rest-api/requests/bdbs/actions/stop_traffic.md +++ b/content/operate/rs/references/rest-api/requests/bdbs/actions/stop_traffic.md @@ -36,7 +36,7 @@ Use this action to stop read and write traffic on a database. To resume traffic #### Example HTTP request ```sh -POST /bdbs/1/actions/stop_traffic +POST /v1/bdbs/1/actions/stop_traffic ``` #### URL parameters diff --git a/content/operate/rs/references/rest-api/requests/bdbs/alerts.md b/content/operate/rs/references/rest-api/requests/bdbs/alerts.md index 1cd3daa70a..86b257e59f 100644 --- a/content/operate/rs/references/rest-api/requests/bdbs/alerts.md +++ b/content/operate/rs/references/rest-api/requests/bdbs/alerts.md @@ -34,7 +34,7 @@ Get all alert states for all databases. #### Example HTTP request - GET /bdbs/alerts + GET /v1/bdbs/alerts #### Request headers @@ -92,7 +92,7 @@ Get all alert states for a database. #### Example HTTP request - GET /bdbs/alerts/1 + GET /v1/bdbs/alerts/1 #### Request headers @@ -148,7 +148,7 @@ Get a database alert state. #### Example HTTP request - GET /bdbs/alerts/1/bdb_size + GET /v1/bdbs/alerts/1/bdb_size #### Request headers @@ -213,7 +213,7 @@ If passed with the dry_run URL query string, the function will validate the aler #### Example HTTP request - POST /bdbs/alerts/1 + POST /v1/bdbs/alerts/1 #### Example JSON body diff --git a/content/operate/rs/references/rest-api/requests/bdbs/availability.md b/content/operate/rs/references/rest-api/requests/bdbs/availability.md index 143bcfc7e1..9b39f84360 100644 --- a/content/operate/rs/references/rest-api/requests/bdbs/availability.md +++ b/content/operate/rs/references/rest-api/requests/bdbs/availability.md @@ -35,7 +35,7 @@ Verifies the local database endpoint is available. This request does not redirec #### Example HTTP request ```sh -GET /local/bdbs/1/endpoint/availability +GET /v1/local/bdbs/1/endpoint/availability ``` #### Headers @@ -100,7 +100,7 @@ Gets the availability status of a database. #### Example HTTP request ```sh -GET /bdbs/1/availability +GET /v1/bdbs/1/availability ``` #### Headers diff --git a/content/operate/rs/references/rest-api/requests/bdbs/crdt_sources-alerts.md b/content/operate/rs/references/rest-api/requests/bdbs/crdt_sources-alerts.md index 3a4a5d21b4..cb755e06f7 100644 --- a/content/operate/rs/references/rest-api/requests/bdbs/crdt_sources-alerts.md +++ b/content/operate/rs/references/rest-api/requests/bdbs/crdt_sources-alerts.md @@ -34,7 +34,7 @@ Get all alert states for all CRDT sources of all CRDBs. #### Example HTTP request - GET /bdbs/crdt_sources/alerts + GET /v1/bdbs/crdt_sources/alerts #### Request headers @@ -92,7 +92,7 @@ Get all alert states for all crdt sources for a specific local bdb of a CRDB. #### Example HTTP request - GET /bdbs/crdt_sources/alerts/1 + GET /v1/bdbs/crdt_sources/alerts/1 #### Request headers @@ -155,7 +155,7 @@ of a CRDB. #### Example HTTP request - GET /bdbs/crdt_sources/alerts/1/2 + GET /v1/bdbs/crdt_sources/alerts/1/2 #### Request headers @@ -218,7 +218,7 @@ Get a BDB alert state. #### Example HTTP request - GET /bdbs/crdt_sources/alerts/1/2/crdt_src_syncer_connection_error + GET /v1/bdbs/crdt_sources/alerts/1/2/crdt_src_syncer_connection_error #### Request headers diff --git a/content/operate/rs/references/rest-api/requests/bdbs/debuginfo.md b/content/operate/rs/references/rest-api/requests/bdbs/debuginfo.md index 8a55b9a801..c26947a0b4 100644 --- a/content/operate/rs/references/rest-api/requests/bdbs/debuginfo.md +++ b/content/operate/rs/references/rest-api/requests/bdbs/debuginfo.md @@ -32,7 +32,7 @@ Downloads a tar file that contains debug info from all databases. #### Example HTTP request - GET /bdbs/debuginfo + GET /v1/bdbs/debuginfo ### Response {#get-all-response} @@ -70,7 +70,7 @@ Downloads a tar file that contains debug info from the database specified by `bd #### Example HTTP request - GET /bdbs/1/debuginfo + GET /v1/bdbs/1/debuginfo ### Response {#get-response} diff --git a/content/operate/rs/references/rest-api/requests/bdbs/modules/config.md b/content/operate/rs/references/rest-api/requests/bdbs/modules/config.md index cf28f13dd1..a30dd17c74 100644 --- a/content/operate/rs/references/rest-api/requests/bdbs/modules/config.md +++ b/content/operate/rs/references/rest-api/requests/bdbs/modules/config.md @@ -31,7 +31,7 @@ Use the module runtime configuration command (if defined) to configure new argum #### Example HTTP request - POST /bdbs/1/modules/config + POST /v1/bdbs/1/modules/config #### Example JSON body diff --git a/content/operate/rs/references/rest-api/requests/bdbs/modules/upgrade.md b/content/operate/rs/references/rest-api/requests/bdbs/modules/upgrade.md index 38916fdefa..b5ebe61dfa 100644 --- a/content/operate/rs/references/rest-api/requests/bdbs/modules/upgrade.md +++ b/content/operate/rs/references/rest-api/requests/bdbs/modules/upgrade.md @@ -31,7 +31,7 @@ Upgrades module version on a specific BDB. #### Example HTTP request - POST /bdbs/1/modules/upgrade + POST /v1/bdbs/1/modules/upgrade #### Example JSON body diff --git a/content/operate/rs/references/rest-api/requests/bdbs/passwords.md b/content/operate/rs/references/rest-api/requests/bdbs/passwords.md index 7430e142f3..6635e92169 100644 --- a/content/operate/rs/references/rest-api/requests/bdbs/passwords.md +++ b/content/operate/rs/references/rest-api/requests/bdbs/passwords.md @@ -33,7 +33,7 @@ Set a single password for the bdb's default user (i.e., for `AUTH` `` aut #### Example HTTP request - POST /bdbs/1/passwords + POST /v1/bdbs/1/passwords #### Example JSON body @@ -153,7 +153,7 @@ Delete a password from the bdb's default user (i.e., for `AUTH` ` #### Example HTTP request - DELETE /bdbs/1/passwords + DELETE /v1/bdbs/1/passwords #### Example JSON body diff --git a/content/operate/rs/references/rest-api/requests/bdbs/peer_stats.md b/content/operate/rs/references/rest-api/requests/bdbs/peer_stats.md index 00e92f0973..166b0c870e 100644 --- a/content/operate/rs/references/rest-api/requests/bdbs/peer_stats.md +++ b/content/operate/rs/references/rest-api/requests/bdbs/peer_stats.md @@ -35,7 +35,7 @@ Get statistics for all peer instances of a local CRDB instance. #### Example HTTP request ```sh -GET /bdbs/1/peer_stats?interval=5min +GET /v1/bdbs/1/peer_stats?interval=5min ``` #### Headers @@ -127,7 +127,7 @@ Get statistics for a specific CRDB peer instance. #### Example HTTP request ```sh -GET /bdbs/1/peer_stats/3?interval=5min +GET /v1/bdbs/1/peer_stats/3?interval=5min ``` #### Headers diff --git a/content/operate/rs/references/rest-api/requests/bdbs/replica_sources-alerts.md b/content/operate/rs/references/rest-api/requests/bdbs/replica_sources-alerts.md index 760713b6de..21c4e28bd2 100644 --- a/content/operate/rs/references/rest-api/requests/bdbs/replica_sources-alerts.md +++ b/content/operate/rs/references/rest-api/requests/bdbs/replica_sources-alerts.md @@ -34,7 +34,7 @@ Get all alert states for all replica sources of all BDBs. #### Example HTTP request - GET /bdbs/replica_sources/alerts + GET /v1/bdbs/replica_sources/alerts #### Request headers @@ -94,7 +94,7 @@ Get all alert states for all replica sources of a specific bdb. #### Example HTTP request - GET /bdbs/replica_sources/alerts/1 + GET /v1/bdbs/replica_sources/alerts/1 #### Request headers @@ -156,7 +156,7 @@ Get all alert states for a specific replica source of a bdb. #### Example HTTP request - GET /bdbs/replica_sources/alerts/1/2 + GET /v1/bdbs/replica_sources/alerts/1/2 #### Request headers @@ -219,7 +219,7 @@ Get a replica source alert state of a specific bdb. #### Example HTTP request - GET /bdbs/replica_sources/alerts/1/2/replica_src_syncer_connection_error + GET /v1/bdbs/replica_sources/alerts/1/2/replica_src_syncer_connection_error #### Request headers diff --git a/content/operate/rs/references/rest-api/requests/bdbs/shards.md b/content/operate/rs/references/rest-api/requests/bdbs/shards.md index 4ea6207cb6..6f358c6cdf 100644 --- a/content/operate/rs/references/rest-api/requests/bdbs/shards.md +++ b/content/operate/rs/references/rest-api/requests/bdbs/shards.md @@ -25,7 +25,7 @@ Gets the status for all shards that belong to the specified database. #### Example HTTP request - GET /bdbs/1/shards?extra_info_keys=used_memory_rss&extra_info_keys=connected_clients + GET /v1/bdbs/1/shards?extra_info_keys=used_memory_rss&extra_info_keys=connected_clients #### Request headers diff --git a/content/operate/rs/references/rest-api/requests/bdbs/stats/_index.md b/content/operate/rs/references/rest-api/requests/bdbs/stats/_index.md index 80b25ab042..8e389873dc 100644 --- a/content/operate/rs/references/rest-api/requests/bdbs/stats/_index.md +++ b/content/operate/rs/references/rest-api/requests/bdbs/stats/_index.md @@ -36,7 +36,7 @@ Get statistics for all databases. #### Example HTTP request ```sh -GET /bdbs/stats?interval=1hour&stime=2014-08-28T10:00:00Z +GET /v1/bdbs/stats?interval=1hour&stime=2014-08-28T10:00:00Z ``` #### Headers @@ -177,7 +177,7 @@ Get statistics for a specific database. #### Example HTTP request ```sh -GET /bdbs/stats/1?interval=1hour&stime=2014-08-28T10:00:00Z +GET /v1/bdbs/stats/1?interval=1hour&stime=2014-08-28T10:00:00Z ``` #### Headers diff --git a/content/operate/rs/references/rest-api/requests/bdbs/stats/last.md b/content/operate/rs/references/rest-api/requests/bdbs/stats/last.md index 6bef3c195f..ed86457d46 100644 --- a/content/operate/rs/references/rest-api/requests/bdbs/stats/last.md +++ b/content/operate/rs/references/rest-api/requests/bdbs/stats/last.md @@ -36,12 +36,12 @@ Get the most recent statistics for all databases. 1. Without metrics filter (returns all metrics by default) ``` - GET /bdbs/stats/last + GET /v1/bdbs/stats/last ``` 2. With metrics filter ``` - GET /bdbs/stats/last?metrics=no_of_keys,used_memory + GET /v1/bdbs/stats/last?metrics=no_of_keys,used_memory ``` #### Request headers @@ -153,7 +153,7 @@ Get the most recent statistics for a specific database. #### Example HTTP request ```sh -GET /bdbs/stats/last/1?metrics=no_of_keys,used_memory +GET /v1/bdbs/stats/last/1?metrics=no_of_keys,used_memory ``` #### Request headers diff --git a/content/operate/rs/references/rest-api/requests/bdbs/sync_source_stats.md b/content/operate/rs/references/rest-api/requests/bdbs/sync_source_stats.md index 3e4fc426fe..3bb9c76ede 100644 --- a/content/operate/rs/references/rest-api/requests/bdbs/sync_source_stats.md +++ b/content/operate/rs/references/rest-api/requests/bdbs/sync_source_stats.md @@ -35,7 +35,7 @@ Get stats for all syncer sources of a local database. #### Example HTTP request ```sh -GET /bdbs/1/sync_source_stats?interval=5min +GET /v1/bdbs/1/sync_source_stats?interval=5min ``` #### Headers @@ -118,7 +118,7 @@ Get stats for a specific syncer (Replica Of) instance. #### Example HTTP request ```sh -GET /bdbs/1/sync_source_stats/1?interval=5min +GET /v1/bdbs/1/sync_source_stats/1?interval=5min ``` #### Headers diff --git a/content/operate/rs/references/rest-api/requests/bdbs/upgrade.md b/content/operate/rs/references/rest-api/requests/bdbs/upgrade.md index d257bce995..3761fa5494 100644 --- a/content/operate/rs/references/rest-api/requests/bdbs/upgrade.md +++ b/content/operate/rs/references/rest-api/requests/bdbs/upgrade.md @@ -31,7 +31,7 @@ Upgrade a database. #### Example HTTP request - POST /bdbs/1/upgrade + POST /v1/bdbs/1/upgrade #### Example JSON body diff --git a/content/operate/rs/references/rest-api/requests/bootstrap/_index.md b/content/operate/rs/references/rest-api/requests/bootstrap/_index.md index bcda287a70..3d0538fa6e 100644 --- a/content/operate/rs/references/rest-api/requests/bootstrap/_index.md +++ b/content/operate/rs/references/rest-api/requests/bootstrap/_index.md @@ -34,7 +34,7 @@ Once the node is part of an active cluster, authentication is required. #### Example HTTP request ```sh -GET /bootstrap +GET /v1/bootstrap ``` #### Headers @@ -155,7 +155,7 @@ complete. #### Example HTTP request ```sh -POST /bootstrap/create_cluster +POST /v1/bootstrap/create_cluster ``` #### Example JSON body diff --git a/content/operate/rs/references/rest-api/requests/bootstrap/validate.md b/content/operate/rs/references/rest-api/requests/bootstrap/validate.md index 8930529554..19ded50fc7 100644 --- a/content/operate/rs/references/rest-api/requests/bootstrap/validate.md +++ b/content/operate/rs/references/rest-api/requests/bootstrap/validate.md @@ -28,7 +28,7 @@ returns with a response. #### Example HTTP request - POST /bootstrap/validate/join_cluster + POST /v1/bootstrap/validate/join_cluster #### Request body diff --git a/content/operate/rs/references/rest-api/requests/cluster/_index.md b/content/operate/rs/references/rest-api/requests/cluster/_index.md index 1db0b21268..5f9232be2b 100644 --- a/content/operate/rs/references/rest-api/requests/cluster/_index.md +++ b/content/operate/rs/references/rest-api/requests/cluster/_index.md @@ -33,7 +33,7 @@ Get cluster info. #### Example HTTP request - GET /cluster + GET /v1/cluster #### Request headers @@ -90,7 +90,7 @@ changes. #### Example HTTP request - PUT /cluster + PUT /v1/cluster #### Example JSON body diff --git a/content/operate/rs/references/rest-api/requests/cluster/actions.md b/content/operate/rs/references/rest-api/requests/cluster/actions.md index feb130bdaa..c58f3ad998 100644 --- a/content/operate/rs/references/rest-api/requests/cluster/actions.md +++ b/content/operate/rs/references/rest-api/requests/cluster/actions.md @@ -34,7 +34,7 @@ Get the status of all currently executing, queued, or completed cluster actions. #### Example HTTP request - GET /cluster/actions + GET /v1/cluster/actions ### Response {#get-all-response} @@ -77,7 +77,7 @@ Get the status of a currently executing, queued, or completed cluster action. #### Example HTTP request - GET /cluster/actions/action_name + GET /v1/cluster/actions/action_name #### URL parameters @@ -130,7 +130,7 @@ removed as soon as the new one is submitted. #### Example HTTP request - POST /cluster/actions/action_name + POST /v1/cluster/actions/action_name #### URL parameters diff --git a/content/operate/rs/references/rest-api/requests/cluster/alerts.md b/content/operate/rs/references/rest-api/requests/cluster/alerts.md index af2657679c..5bc61d3e85 100644 --- a/content/operate/rs/references/rest-api/requests/cluster/alerts.md +++ b/content/operate/rs/references/rest-api/requests/cluster/alerts.md @@ -32,7 +32,7 @@ Get all alert states for the cluster object. #### Example HTTP request - GET /cluster/alerts + GET /v1/cluster/alerts #### Request headers @@ -90,7 +90,7 @@ Get a cluster alert state. #### Example HTTP request - GET /cluster/alerts/cluster_too_few_nodes_for_replication + GET /v1/cluster/alerts/cluster_too_few_nodes_for_replication #### Request headers diff --git a/content/operate/rs/references/rest-api/requests/cluster/auditing-db-conns.md b/content/operate/rs/references/rest-api/requests/cluster/auditing-db-conns.md index f9dfba2365..eabb0aa362 100644 --- a/content/operate/rs/references/rest-api/requests/cluster/auditing-db-conns.md +++ b/content/operate/rs/references/rest-api/requests/cluster/auditing-db-conns.md @@ -33,7 +33,7 @@ Gets the configuration settings for [auditing database connections]({{< relref " #### Example HTTP request - GET /cluster/auditing/db_conns + GET /v1/cluster/auditing/db_conns #### Request headers @@ -90,7 +90,7 @@ Updates the configuration settings for [auditing database connections]({{< relre #### Example HTTP request - PUT /cluster/auditing/db_conns + PUT /v1/cluster/auditing/db_conns #### Example JSON body @@ -162,7 +162,7 @@ Resets the configuration settings for [auditing database connections]({{< relref #### Example HTTP request - DELETE /cluster/auditing/db_conns + DELETE /v1/cluster/auditing/db_conns #### Request headers diff --git a/content/operate/rs/references/rest-api/requests/cluster/certificates/_index.md b/content/operate/rs/references/rest-api/requests/cluster/certificates/_index.md index fc8bd7c2bb..8e221e2048 100644 --- a/content/operate/rs/references/rest-api/requests/cluster/certificates/_index.md +++ b/content/operate/rs/references/rest-api/requests/cluster/certificates/_index.md @@ -34,7 +34,7 @@ Get the cluster's certificates. #### Example HTTP request - GET /cluster/certificates + GET /v1/cluster/certificates #### Request headers @@ -80,7 +80,7 @@ See the [certificates table]({{< relref "/operate/rs/security/certificates" >}}) #### Example HTTP request ```sh -PUT /cluster/update_cert +PUT /v1/cluster/update_cert ``` #### Example JSON body @@ -125,7 +125,7 @@ this endpoint. See the [certificates table]({{< relref "/operate/rs/security/cer #### Example HTTP request - DELETE /cluster/certificates/ + DELETE /v1/cluster/certificates/ #### Request headers diff --git a/content/operate/rs/references/rest-api/requests/cluster/certificates/rotate.md b/content/operate/rs/references/rest-api/requests/cluster/certificates/rotate.md index 8232e54c27..d2456cfce4 100644 --- a/content/operate/rs/references/rest-api/requests/cluster/certificates/rotate.md +++ b/content/operate/rs/references/rest-api/requests/cluster/certificates/rotate.md @@ -28,7 +28,7 @@ The certificate rotation will be performed on all nodes within the cluster. If #### Example HTTP request - POST /cluster/certificates/rotate + POST /v1/cluster/certificates/rotate #### Request headers diff --git a/content/operate/rs/references/rest-api/requests/cluster/check.md b/content/operate/rs/references/rest-api/requests/cluster/check.md index b05e247795..7b3383c301 100644 --- a/content/operate/rs/references/rest-api/requests/cluster/check.md +++ b/content/operate/rs/references/rest-api/requests/cluster/check.md @@ -43,7 +43,7 @@ Runs the following checks on all cluster nodes: #### Example HTTP request - GET /cluster/check + GET /v1/cluster/check #### Request headers diff --git a/content/operate/rs/references/rest-api/requests/cluster/debuginfo.md b/content/operate/rs/references/rest-api/requests/cluster/debuginfo.md index 0511632a2a..04cff985cf 100644 --- a/content/operate/rs/references/rest-api/requests/cluster/debuginfo.md +++ b/content/operate/rs/references/rest-api/requests/cluster/debuginfo.md @@ -31,7 +31,7 @@ Downloads a tar file that contains debug info from all nodes and databases. #### Example HTTP request - GET /cluster/debuginfo + GET /v1/cluster/debuginfo ### Response {#get-response} diff --git a/content/operate/rs/references/rest-api/requests/cluster/ldap.md b/content/operate/rs/references/rest-api/requests/cluster/ldap.md index 2a4d996184..afe7dc0ddf 100644 --- a/content/operate/rs/references/rest-api/requests/cluster/ldap.md +++ b/content/operate/rs/references/rest-api/requests/cluster/ldap.md @@ -33,7 +33,7 @@ Get the LDAP configuration. #### Example HTTP request - GET /cluster/ldap + GET /v1/cluster/ldap #### Request headers @@ -86,7 +86,7 @@ Set or update the cluster LDAP configuration. #### Example HTTP request - POST /cluster/ldap + POST /v1/cluster/ldap #### Example JSON body @@ -150,7 +150,7 @@ Clear the LDAP configuration. #### Example HTTP request - DELETE /cluster/ldap + DELETE /v1/cluster/ldap #### Request headers diff --git a/content/operate/rs/references/rest-api/requests/cluster/module-capabilities.md b/content/operate/rs/references/rest-api/requests/cluster/module-capabilities.md index 319727192a..0a5bb6848b 100644 --- a/content/operate/rs/references/rest-api/requests/cluster/module-capabilities.md +++ b/content/operate/rs/references/rest-api/requests/cluster/module-capabilities.md @@ -31,7 +31,7 @@ List possible Redis module capabilities. #### Example HTTP request - GET /cluster/module-capabilities + GET /v1/cluster/module-capabilities #### Request headers diff --git a/content/operate/rs/references/rest-api/requests/cluster/policy.md b/content/operate/rs/references/rest-api/requests/cluster/policy.md index 29da913bfc..64b2f20111 100644 --- a/content/operate/rs/references/rest-api/requests/cluster/policy.md +++ b/content/operate/rs/references/rest-api/requests/cluster/policy.md @@ -32,7 +32,7 @@ Gets the cluster's current policy settings. #### Example HTTP request - GET /cluster/policy + GET /v1/cluster/policy #### Request headers @@ -82,7 +82,7 @@ Update cluster policy settings. #### Example HTTP request - PUT /cluster/policy + PUT /v1/cluster/policy #### Example JSON body diff --git a/content/operate/rs/references/rest-api/requests/cluster/services_configuration.md b/content/operate/rs/references/rest-api/requests/cluster/services_configuration.md index 4cd5b330a6..f6c5fa5c90 100644 --- a/content/operate/rs/references/rest-api/requests/cluster/services_configuration.md +++ b/content/operate/rs/references/rest-api/requests/cluster/services_configuration.md @@ -32,7 +32,7 @@ Get cluster services settings. #### Example HTTP request - GET /cluster/services_configuration + GET /v1/cluster/services_configuration #### Request headers @@ -81,7 +81,7 @@ Update the cluster services settings. #### Example HTTP request - PUT /cluster/services_configuration + PUT /v1/cluster/services_configuration #### Example JSON body diff --git a/content/operate/rs/references/rest-api/requests/cluster/stats/_index.md b/content/operate/rs/references/rest-api/requests/cluster/stats/_index.md index 938449166c..c500ef9887 100644 --- a/content/operate/rs/references/rest-api/requests/cluster/stats/_index.md +++ b/content/operate/rs/references/rest-api/requests/cluster/stats/_index.md @@ -35,7 +35,7 @@ Get cluster statistics. #### Example HTTP request ```sh -GET /cluster/stats/1?interval=1hour&stime=2014-08-28T10:00:00Z +GET /v1/cluster/stats/1?interval=1hour&stime=2014-08-28T10:00:00Z ``` #### Headers diff --git a/content/operate/rs/references/rest-api/requests/cluster/stats/last.md b/content/operate/rs/references/rest-api/requests/cluster/stats/last.md index d95102c52a..d39680c1d9 100644 --- a/content/operate/rs/references/rest-api/requests/cluster/stats/last.md +++ b/content/operate/rs/references/rest-api/requests/cluster/stats/last.md @@ -31,7 +31,7 @@ Get the most recent cluster statistics. #### Example HTTP request - GET /cluster/stats/last?interval=1sec&stime=2015-10-14T06:44:00Z + GET /v1/cluster/stats/last?interval=1sec&stime=2015-10-14T06:44:00Z #### Request headers diff --git a/content/operate/rs/references/rest-api/requests/cm_settings/_index.md b/content/operate/rs/references/rest-api/requests/cm_settings/_index.md index 19fb278e98..a2cb902b14 100644 --- a/content/operate/rs/references/rest-api/requests/cm_settings/_index.md +++ b/content/operate/rs/references/rest-api/requests/cm_settings/_index.md @@ -36,7 +36,7 @@ Get Cluster Manager UI settings. #### Example HTTP request ```sh -GET /cm_settings +GET /v1/cm_settings ``` #### Headers @@ -83,7 +83,7 @@ Update Cluster Manager UI settings. #### Example HTTP request ```sh -PUT /cm_settings +PUT /v1/cm_settings ``` #### Example JSON body diff --git a/content/operate/rs/references/rest-api/requests/crdb_tasks/_index.md b/content/operate/rs/references/rest-api/requests/crdb_tasks/_index.md index b0ea2925e3..69130b5362 100644 --- a/content/operate/rs/references/rest-api/requests/crdb_tasks/_index.md +++ b/content/operate/rs/references/rest-api/requests/crdb_tasks/_index.md @@ -28,7 +28,7 @@ The status of a completed task is kept for 500 seconds by default. #### Example HTTP request - GET /crdb_tasks/1 + GET /v1/crdb_tasks/1 #### Request headers diff --git a/content/operate/rs/references/rest-api/requests/crdbs/_index.md b/content/operate/rs/references/rest-api/requests/crdbs/_index.md index 79a1842adf..47d7f26c0c 100644 --- a/content/operate/rs/references/rest-api/requests/crdbs/_index.md +++ b/content/operate/rs/references/rest-api/requests/crdbs/_index.md @@ -33,7 +33,7 @@ Get a list of all Active-Active databases on the cluster. #### Example HTTP request ```sh -GET /crdbs +GET /v1/crdbs ``` #### Headers @@ -67,7 +67,7 @@ Get a specific Active-Active database. #### Example HTTP request ```sh - GET /crdbs/552bbccb-99f3-4142-bd17-93d245f0bc79 + GET /v1/crdbs/552bbccb-99f3-4142-bd17-93d245f0bc79 ``` #### Headers @@ -116,7 +116,7 @@ In order to add or remove instances, use [`POST crdbs/{crdb_guid}/updates` #### Example HTTP request ```sh - PATCH /crdbs/552bbccb-99f3-4142-bd17-93d245f0bc79 + PATCH /v1/crdbs/552bbccb-99f3-4142-bd17-93d245f0bc79 ``` #### Headers @@ -163,7 +163,7 @@ Create a new Active-Active database. #### Example HTTP request ```sh - POST /crdbs + POST /v1/crdbs ``` #### Headers @@ -247,7 +247,7 @@ Delete an Active-Active database. #### Example HTTP request ```sh - DELETE /crdbs/552bbccb-99f3-4142-bd17-93d245f0bc79 + DELETE /v1/crdbs/552bbccb-99f3-4142-bd17-93d245f0bc79 ``` #### Headers diff --git a/content/operate/rs/references/rest-api/requests/crdbs/flush.md b/content/operate/rs/references/rest-api/requests/crdbs/flush.md index 951806a1d9..1b3d2079fa 100644 --- a/content/operate/rs/references/rest-api/requests/crdbs/flush.md +++ b/content/operate/rs/references/rest-api/requests/crdbs/flush.md @@ -28,7 +28,7 @@ Flush an Active-Active database. #### Example HTTP request ```sh -PUT /crdbs/552bbccb-99f3-4142-bd17-93d245f0bc79/flush +PUT /v1/crdbs/552bbccb-99f3-4142-bd17-93d245f0bc79/flush ``` #### Headers diff --git a/content/operate/rs/references/rest-api/requests/crdbs/health_report.md b/content/operate/rs/references/rest-api/requests/crdbs/health_report.md index 61d5b0d89c..93281ee0f9 100644 --- a/content/operate/rs/references/rest-api/requests/crdbs/health_report.md +++ b/content/operate/rs/references/rest-api/requests/crdbs/health_report.md @@ -25,7 +25,7 @@ Get a health report for an Active-Active database. #### Example HTTP request - GET /crdbs/{crdb_guid}/health_report + GET /v1/crdbs/{crdb_guid}/health_report #### URL parameters diff --git a/content/operate/rs/references/rest-api/requests/crdbs/purge.md b/content/operate/rs/references/rest-api/requests/crdbs/purge.md index 78c27641c7..f3746f4aa3 100644 --- a/content/operate/rs/references/rest-api/requests/crdbs/purge.md +++ b/content/operate/rs/references/rest-api/requests/crdbs/purge.md @@ -34,7 +34,7 @@ removed instance). #### Example HTTP request - PUT /crdbs/1/purge + PUT /v1/crdbs/1/purge #### URL parameters diff --git a/content/operate/rs/references/rest-api/requests/crdbs/updates.md b/content/operate/rs/references/rest-api/requests/crdbs/updates.md index 69c1b1d9f3..664e600a38 100644 --- a/content/operate/rs/references/rest-api/requests/crdbs/updates.md +++ b/content/operate/rs/references/rest-api/requests/crdbs/updates.md @@ -35,7 +35,7 @@ When you update db_config, it changes the configuration of the database that you #### Example HTTP request - POST /crdbs/1/updates + POST /v1/crdbs/1/updates #### Request headers diff --git a/content/operate/rs/references/rest-api/requests/debuginfo/all/_index.md b/content/operate/rs/references/rest-api/requests/debuginfo/all/_index.md index 6339d9d1e7..dfd8170f09 100644 --- a/content/operate/rs/references/rest-api/requests/debuginfo/all/_index.md +++ b/content/operate/rs/references/rest-api/requests/debuginfo/all/_index.md @@ -36,7 +36,7 @@ Downloads a tar file that contains debug info from all nodes. #### Example HTTP request - GET /debuginfo/all + GET /v1/debuginfo/all ### Response {#get-all-response} diff --git a/content/operate/rs/references/rest-api/requests/debuginfo/all/bdb.md b/content/operate/rs/references/rest-api/requests/debuginfo/all/bdb.md index d53625bc3f..99cca35847 100644 --- a/content/operate/rs/references/rest-api/requests/debuginfo/all/bdb.md +++ b/content/operate/rs/references/rest-api/requests/debuginfo/all/bdb.md @@ -35,7 +35,7 @@ Downloads a tar file that contains debug info for the specified database (`bdb_u #### Example HTTP request - GET /debuginfo/all/bdb/1 + GET /v1/debuginfo/all/bdb/1 ### Response {#get-all-response} diff --git a/content/operate/rs/references/rest-api/requests/debuginfo/node/_index.md b/content/operate/rs/references/rest-api/requests/debuginfo/node/_index.md index 1dab22b085..6b5f29c957 100644 --- a/content/operate/rs/references/rest-api/requests/debuginfo/node/_index.md +++ b/content/operate/rs/references/rest-api/requests/debuginfo/node/_index.md @@ -36,7 +36,7 @@ Downloads a tar file that contains debug info for the current node. #### Example HTTP request - GET /debuginfo/node + GET /v1/debuginfo/node ### Response {#get-response} diff --git a/content/operate/rs/references/rest-api/requests/debuginfo/node/bdb.md b/content/operate/rs/references/rest-api/requests/debuginfo/node/bdb.md index 3e44924a18..ccff129fdd 100644 --- a/content/operate/rs/references/rest-api/requests/debuginfo/node/bdb.md +++ b/content/operate/rs/references/rest-api/requests/debuginfo/node/bdb.md @@ -35,7 +35,7 @@ Downloads a tar file that contains debug info for the specified database (`bdb_u #### Example HTTP request - GET /debuginfo/node/bdb/1 + GET /v1/debuginfo/node/bdb/1 ### Response {#get-response} diff --git a/content/operate/rs/references/rest-api/requests/endpoints-stats/_index.md b/content/operate/rs/references/rest-api/requests/endpoints-stats/_index.md index aaab0b004e..74bd7208e7 100644 --- a/content/operate/rs/references/rest-api/requests/endpoints-stats/_index.md +++ b/content/operate/rs/references/rest-api/requests/endpoints-stats/_index.md @@ -37,7 +37,7 @@ compatability. #### Example HTTP request - GET /endpoints/stats?interval=1hour&stime=2014-08-28T10:00:00Z + GET /v1/endpoints/stats?interval=1hour&stime=2014-08-28T10:00:00Z #### Request headers diff --git a/content/operate/rs/references/rest-api/requests/jsonschema/_index.md b/content/operate/rs/references/rest-api/requests/jsonschema/_index.md index a2d8bbaf41..66ba9a8997 100644 --- a/content/operate/rs/references/rest-api/requests/jsonschema/_index.md +++ b/content/operate/rs/references/rest-api/requests/jsonschema/_index.md @@ -26,7 +26,7 @@ Get the JSON schema of various [Redis Enterprise REST API objects]({{< relref "/ #### Example HTTP request - GET /jsonschema?object=bdb + GET /v1/jsonschema?object=bdb #### Request headers diff --git a/content/operate/rs/references/rest-api/requests/ldap_mappings/_index.md b/content/operate/rs/references/rest-api/requests/ldap_mappings/_index.md index 1f78c28a66..0d9adf0540 100644 --- a/content/operate/rs/references/rest-api/requests/ldap_mappings/_index.md +++ b/content/operate/rs/references/rest-api/requests/ldap_mappings/_index.md @@ -36,7 +36,7 @@ Get all LDAP mappings. #### Example HTTP request - GET /ldap_mappings + GET /v1/ldap_mappings #### Request headers @@ -88,7 +88,7 @@ Get a specific LDAP mapping. #### Example HTTP request - GET /ldap_mappings/1 + GET /v1/ldap_mappings/1 #### Request headers @@ -156,7 +156,7 @@ Update an existing ldap_mapping object. #### Example HTTP request - PUT /ldap_mappings/17 + PUT /v1/ldap_mappings/17 #### Example JSON body @@ -238,7 +238,7 @@ Create a new LDAP mapping. #### Example HTTP request - POST /ldap_mappings + POST /v1/ldap_mappings #### Example JSON body @@ -314,7 +314,7 @@ Delete an LDAP mapping object. #### Example HTTP request - DELETE /ldap_mappings/1 + DELETE /v1/ldap_mappings/1 #### Request headers diff --git a/content/operate/rs/references/rest-api/requests/license/_index.md b/content/operate/rs/references/rest-api/requests/license/_index.md index 8907180937..6171e32c66 100644 --- a/content/operate/rs/references/rest-api/requests/license/_index.md +++ b/content/operate/rs/references/rest-api/requests/license/_index.md @@ -34,7 +34,7 @@ and supported features. #### Example HTTP request - GET /license + GET /v1/license #### Request headers @@ -111,7 +111,7 @@ The request must be a JSON object with a single key named "license". #### Example HTTP request - PUT /license + PUT /v1/license #### Example JSON body diff --git a/content/operate/rs/references/rest-api/requests/logs/_index.md b/content/operate/rs/references/rest-api/requests/logs/_index.md index 555e5b8f7c..dcc1c4489b 100644 --- a/content/operate/rs/references/rest-api/requests/logs/_index.md +++ b/content/operate/rs/references/rest-api/requests/logs/_index.md @@ -32,7 +32,7 @@ Get cluster events log. #### Example HTTP request - GET /logs?order=desc + GET /v1/logs?order=desc #### Request headers diff --git a/content/operate/rs/references/rest-api/requests/modules/_index.md b/content/operate/rs/references/rest-api/requests/modules/_index.md index df96ca2546..94dc813480 100644 --- a/content/operate/rs/references/rest-api/requests/modules/_index.md +++ b/content/operate/rs/references/rest-api/requests/modules/_index.md @@ -40,7 +40,7 @@ List available modules, i.e. modules stored within the CCS. #### Example HTTP request ```sh -GET /modules +GET /v1/modules ``` #### Headers @@ -79,7 +79,7 @@ Get specific available modules, i.e. modules stored within the CCS. #### Example HTTP request ```sh -GET /modules/1 +GET /v1/modules/1 ``` #### Headers diff --git a/content/operate/rs/references/rest-api/requests/modules/config.md b/content/operate/rs/references/rest-api/requests/modules/config.md index 27f3a6ff9e..38264ac1c1 100644 --- a/content/operate/rs/references/rest-api/requests/modules/config.md +++ b/content/operate/rs/references/rest-api/requests/modules/config.md @@ -31,7 +31,7 @@ Use the module runtime configuration command (if defined) to configure new argum #### Example HTTP request - POST /modules/config/bdb/1 + POST /v1/modules/config/bdb/1 #### Example JSON body diff --git a/content/operate/rs/references/rest-api/requests/modules/upgrade.md b/content/operate/rs/references/rest-api/requests/modules/upgrade.md index 6e443ba9e8..39880ac4a5 100644 --- a/content/operate/rs/references/rest-api/requests/modules/upgrade.md +++ b/content/operate/rs/references/rest-api/requests/modules/upgrade.md @@ -31,7 +31,7 @@ Upgrades the module version on a specific database. Deprecated as of Redis Enter #### Example HTTP request - POST /modules/upgrade/bdb/1 + POST /v1/modules/upgrade/bdb/1 #### Example JSON body diff --git a/content/operate/rs/references/rest-api/requests/nodes/_index.md b/content/operate/rs/references/rest-api/requests/nodes/_index.md index 13f8947415..d758f66378 100644 --- a/content/operate/rs/references/rest-api/requests/nodes/_index.md +++ b/content/operate/rs/references/rest-api/requests/nodes/_index.md @@ -37,7 +37,7 @@ Get all cluster nodes. #### Example HTTP request ```sh -GET /nodes +GET /v1/nodes ``` #### Headers @@ -121,7 +121,7 @@ Get a single cluster node. #### Example HTTP request ```sh -GET /nodes/1 +GET /v1/nodes/1 ``` #### Headers @@ -191,7 +191,7 @@ You can only update the `addr` attribute for offline nodes. Otherwise, the reque #### Example HTTP request ```sh -PUT /nodes/1 +PUT /v1/nodes/1 ``` #### Example JSON body diff --git a/content/operate/rs/references/rest-api/requests/nodes/actions.md b/content/operate/rs/references/rest-api/requests/nodes/actions.md index 00c2f1ca43..acd512d937 100644 --- a/content/operate/rs/references/rest-api/requests/nodes/actions.md +++ b/content/operate/rs/references/rest-api/requests/nodes/actions.md @@ -39,7 +39,7 @@ actions on all nodes. #### Example HTTP request ```sh -GET /nodes/actions +GET /v1/nodes/actions ``` #### Request headers @@ -78,7 +78,7 @@ Get the status of all actions on a specific node. #### Example HTTP request ```sh -GET /nodes/1/actions +GET /v1/nodes/1/actions ``` #### Request headers @@ -142,7 +142,7 @@ Get the status of a currently executing, queued, or completed action on a specif #### Example HTTP request ```sh -GET /nodes/1/actions/remove +GET /v1/nodes/1/actions/remove ``` #### Headers @@ -197,7 +197,7 @@ removed as soon as the new one is submitted. #### Example HTTP request ```sh -POST /nodes/1/actions/remove +POST /v1/nodes/1/actions/remove ``` #### Headers @@ -329,7 +329,7 @@ previously executed and completed action. #### Example HTTP request ```sh -DELETE /nodes/1/actions/remove +DELETE /v1/nodes/1/actions/remove ``` #### Headers diff --git a/content/operate/rs/references/rest-api/requests/nodes/alerts.md b/content/operate/rs/references/rest-api/requests/nodes/alerts.md index 6f6efa2139..549140ba37 100644 --- a/content/operate/rs/references/rest-api/requests/nodes/alerts.md +++ b/content/operate/rs/references/rest-api/requests/nodes/alerts.md @@ -33,7 +33,7 @@ Get all alert states for all nodes. #### Example HTTP request - GET /nodes/alerts + GET /v1/nodes/alerts #### Request headers @@ -96,7 +96,7 @@ Get all alert states for a node. #### Example HTTP request - GET /nodes/alerts/1 + GET /v1/nodes/alerts/1 #### Request headers @@ -159,7 +159,7 @@ Get a node alert state. #### Example HTTP request - GET /nodes/alerts/1/node_cpu_utilization + GET /v1/nodes/alerts/1/node_cpu_utilization #### Request headers diff --git a/content/operate/rs/references/rest-api/requests/nodes/check.md b/content/operate/rs/references/rest-api/requests/nodes/check.md index 9275f9df90..f5f93cf04d 100644 --- a/content/operate/rs/references/rest-api/requests/nodes/check.md +++ b/content/operate/rs/references/rest-api/requests/nodes/check.md @@ -43,7 +43,7 @@ Runs the following checks on a cluster node: #### Example HTTP request - GET /nodes/check/1 + GET /v1/nodes/check/1 #### Request headers diff --git a/content/operate/rs/references/rest-api/requests/nodes/debuginfo.md b/content/operate/rs/references/rest-api/requests/nodes/debuginfo.md index d0b103fa43..a8ad703c5b 100644 --- a/content/operate/rs/references/rest-api/requests/nodes/debuginfo.md +++ b/content/operate/rs/references/rest-api/requests/nodes/debuginfo.md @@ -32,7 +32,7 @@ Downloads a tar file that contains debug info from all nodes. #### Example HTTP request - GET /nodes/debuginfo + GET /v1/nodes/debuginfo ### Response {#get-all-response} @@ -69,7 +69,7 @@ Downloads a tar file that contains debug info from a specific node. #### Example HTTP request - GET /nodes/1/debuginfo + GET /v1/nodes/1/debuginfo ### Response {#get-response} diff --git a/content/operate/rs/references/rest-api/requests/nodes/snapshots.md b/content/operate/rs/references/rest-api/requests/nodes/snapshots.md index 62ecebb9d2..d0eef82e98 100644 --- a/content/operate/rs/references/rest-api/requests/nodes/snapshots.md +++ b/content/operate/rs/references/rest-api/requests/nodes/snapshots.md @@ -35,7 +35,7 @@ Get all cluster node snapshots of the specified node. #### Example HTTP request ```sh -GET /nodes/1/snapshots +GET /v1/nodes/1/snapshots ``` #### Headers @@ -98,7 +98,7 @@ Delete a cluster node snapshot. Snapshots created by maintenance mode are not de #### Example HTTP request ```sh -DELETE /nodes/1/snapshots/nightly_snapshot_19 +DELETE /v1/nodes/1/snapshots/nightly_snapshot_19 ``` #### Request headers diff --git a/content/operate/rs/references/rest-api/requests/nodes/stats/_index.md b/content/operate/rs/references/rest-api/requests/nodes/stats/_index.md index cc0bac9de5..92484bac33 100644 --- a/content/operate/rs/references/rest-api/requests/nodes/stats/_index.md +++ b/content/operate/rs/references/rest-api/requests/nodes/stats/_index.md @@ -36,7 +36,7 @@ Get statistics for all nodes. #### Example HTTP request ```sh -GET /nodes/stats?interval=1hour&stime=2014-08-28T10:00:00Z +GET /v1/nodes/stats?interval=1hour&stime=2014-08-28T10:00:00Z ``` #### Request headers @@ -149,7 +149,7 @@ Get statistics for a node. #### Example HTTP request ```sh -GET /nodes/stats/1?interval=1hour&stime=2014-08-28T10:00:00Z +GET /v1/nodes/stats/1?interval=1hour&stime=2014-08-28T10:00:00Z ``` #### Request headers diff --git a/content/operate/rs/references/rest-api/requests/nodes/stats/last.md b/content/operate/rs/references/rest-api/requests/nodes/stats/last.md index 7827cc97fd..552e38302c 100644 --- a/content/operate/rs/references/rest-api/requests/nodes/stats/last.md +++ b/content/operate/rs/references/rest-api/requests/nodes/stats/last.md @@ -35,7 +35,7 @@ Get latest statistics for all nodes. #### Example HTTP request ```sh -GET /nodes/stats/last?interval=1sec&stime=2015-10-14T06:29:43Z +GET /v1/nodes/stats/last?interval=1sec&stime=2015-10-14T06:29:43Z ``` @@ -115,7 +115,7 @@ Get the latest statistics of a node. #### Example HTTP request ```sh -GET /nodes/stats/last/1?interval=1sec&stime=2015-10-13T09:01:54Z +GET /v1/nodes/stats/last/1?interval=1sec&stime=2015-10-13T09:01:54Z ``` diff --git a/content/operate/rs/references/rest-api/requests/nodes/status.md b/content/operate/rs/references/rest-api/requests/nodes/status.md index e7db1e1fc2..b29c6e4814 100644 --- a/content/operate/rs/references/rest-api/requests/nodes/status.md +++ b/content/operate/rs/references/rest-api/requests/nodes/status.md @@ -37,7 +37,7 @@ Gets the status of all nodes. Includes each node's hostname and role in the clus #### Example HTTP request - GET /nodes/status + GET /v1/nodes/status #### Request headers @@ -116,7 +116,7 @@ Gets the status of a node. Includes the node's hostname and role in the cluster: #### Example HTTP request - GET /nodes/1/status + GET /v1/nodes/1/status #### Request headers diff --git a/content/operate/rs/references/rest-api/requests/ocsp/_index.md b/content/operate/rs/references/rest-api/requests/ocsp/_index.md index 97a1ec674a..466e195ea8 100644 --- a/content/operate/rs/references/rest-api/requests/ocsp/_index.md +++ b/content/operate/rs/references/rest-api/requests/ocsp/_index.md @@ -33,7 +33,7 @@ Gets the cluster's OCSP configuration. #### Example HTTP request - GET /ocsp + GET /v1/ocsp #### Request headers @@ -91,7 +91,7 @@ Updates the cluster's OCSP configuration. #### Example HTTP request - PUT /ocsp + PUT /v1/ocsp #### Example JSON body diff --git a/content/operate/rs/references/rest-api/requests/ocsp/status.md b/content/operate/rs/references/rest-api/requests/ocsp/status.md index 910f9d67d0..9b6a5d126c 100644 --- a/content/operate/rs/references/rest-api/requests/ocsp/status.md +++ b/content/operate/rs/references/rest-api/requests/ocsp/status.md @@ -31,7 +31,7 @@ Gets the latest cached status of the proxy certificate’s OCSP response. #### Example HTTP request - GET /ocsp/status + GET /v1/ocsp/status #### Request headers diff --git a/content/operate/rs/references/rest-api/requests/ocsp/test.md b/content/operate/rs/references/rest-api/requests/ocsp/test.md index 9664d3b2d0..6f7683815b 100644 --- a/content/operate/rs/references/rest-api/requests/ocsp/test.md +++ b/content/operate/rs/references/rest-api/requests/ocsp/test.md @@ -31,7 +31,7 @@ Queries the OCSP server for the proxy certificate’s latest status and returns #### Example HTTP request - POST /ocsp/test + POST /v1/ocsp/test #### Request headers diff --git a/content/operate/rs/references/rest-api/requests/proxies/_index.md b/content/operate/rs/references/rest-api/requests/proxies/_index.md index 5513a44d05..d8ae4546c3 100644 --- a/content/operate/rs/references/rest-api/requests/proxies/_index.md +++ b/content/operate/rs/references/rest-api/requests/proxies/_index.md @@ -38,7 +38,7 @@ Get all the proxies in the cluster. #### Example HTTP request ```sh -GET /proxies +GET /v1/proxies ``` #### Headers @@ -109,7 +109,7 @@ Get a single proxy's info. #### Example HTTP request ```sh -GET /proxies/1 +GET /v1/proxies/1 ``` #### Headers @@ -184,7 +184,7 @@ However, if `allow_restart` is `false`, such changes only take effect after the #### Example HTTP request ```sh -PUT /proxies/1 +PUT /v1/proxies/1 ``` #### Example JSON body @@ -253,7 +253,7 @@ However, if `allow_restart` is `false`, such changes only take effect after the #### Example HTTP request ```sh -PUT /proxies +PUT /v1/proxies ``` #### Example JSON body diff --git a/content/operate/rs/references/rest-api/requests/redis_acls/_index.md b/content/operate/rs/references/rest-api/requests/redis_acls/_index.md index f5e18c826d..c2f057431b 100644 --- a/content/operate/rs/references/rest-api/requests/redis_acls/_index.md +++ b/content/operate/rs/references/rest-api/requests/redis_acls/_index.md @@ -39,7 +39,7 @@ Get all Redis ACL objects. #### Example HTTP request ```sh -GET /redis_acls +GET /v1/redis_acls ``` #### Headers @@ -106,7 +106,7 @@ Get a single Redis ACL object. #### Example HTTP request ```sh -GET /redis_acls/1 +GET /v1/redis_acls/1 ``` #### Headers @@ -165,7 +165,7 @@ Update an existing Redis ACL object. #### Example HTTP request ```sh -PUT /redis_acls/17 +PUT /v1/redis_acls/17 ``` #### Example JSON body @@ -250,7 +250,7 @@ Create a new Redis ACL object. #### Example HTTP request ```sh -POST /redis_acls +POST /v1/redis_acls ``` #### Example JSON body @@ -366,7 +366,7 @@ Delete a Redis ACL object. #### Example HTTP request ```sh -DELETE /redis_acls/1 +DELETE /v1/redis_acls/1 ``` #### Headers diff --git a/content/operate/rs/references/rest-api/requests/roles/_index.md b/content/operate/rs/references/rest-api/requests/roles/_index.md index 165d5a8394..6e22c25750 100644 --- a/content/operate/rs/references/rest-api/requests/roles/_index.md +++ b/content/operate/rs/references/rest-api/requests/roles/_index.md @@ -39,7 +39,7 @@ Get all roles' details. #### Example HTTP request ```sh -GET /roles +GET /v1/roles ``` #### Headers @@ -121,7 +121,7 @@ Get the details of a single role. #### Example HTTP request ```sh -GET /roles/1 +GET /v1/roles/1 ``` @@ -181,7 +181,7 @@ Update an existing role's details. #### Example HTTP request ```sh -PUT /roles/17 +PUT /v1/roles/17 ``` #### Example JSON body @@ -256,7 +256,7 @@ Create a new role. #### Example HTTP request ```sh -POST /roles +POST /v1/roles ``` #### Example JSON body @@ -366,7 +366,7 @@ Delete a role object. #### Example HTTP request ```sh -DELETE /roles/1 +DELETE /v1/roles/1 ``` #### Headers diff --git a/content/operate/rs/references/rest-api/requests/services/_index.md b/content/operate/rs/references/rest-api/requests/services/_index.md index 90dffe650c..b56c744af5 100644 --- a/content/operate/rs/references/rest-api/requests/services/_index.md +++ b/content/operate/rs/references/rest-api/requests/services/_index.md @@ -39,7 +39,7 @@ Lists all Redis Enterprise services currently running on the local node and rele #### Example HTTP request ```sh -GET /local/services +GET /v1/local/services ``` @@ -112,7 +112,7 @@ For a list of optional services, see the [services configuration object referenc #### Example HTTP request ```sh -POST /local/services +POST /v1/local/services ``` #### Headers @@ -181,7 +181,7 @@ For a list of optional services, see the [services configuration object referenc #### Example HTTP request ```sh -POST /services +POST /v1/services ``` #### Headers diff --git a/content/operate/rs/references/rest-api/requests/shards/_index.md b/content/operate/rs/references/rest-api/requests/shards/_index.md index 7801b65838..1b4930abfe 100644 --- a/content/operate/rs/references/rest-api/requests/shards/_index.md +++ b/content/operate/rs/references/rest-api/requests/shards/_index.md @@ -27,7 +27,7 @@ Get information about all shards in the cluster. #### Example HTTP request - GET /shards?extra_info_keys=used_memory_rss&extra_info_keys=connected_clients + GET /v1/shards?extra_info_keys=used_memory_rss&extra_info_keys=connected_clients #### Request headers @@ -91,7 +91,7 @@ Gets information about a single shard. #### Example HTTP request - GET /shards/1?extra_info_keys=used_memory_rss&extra_info_keys=connected_clients + GET /v1/shards/1?extra_info_keys=used_memory_rss&extra_info_keys=connected_clients #### Request headers diff --git a/content/operate/rs/references/rest-api/requests/shards/actions/failover.md b/content/operate/rs/references/rest-api/requests/shards/actions/failover.md index 9099c31cd2..de6af9e3c0 100644 --- a/content/operate/rs/references/rest-api/requests/shards/actions/failover.md +++ b/content/operate/rs/references/rest-api/requests/shards/actions/failover.md @@ -34,7 +34,7 @@ The cluster automatically manages failover to ensure high availability. Use this #### Example HTTP request - POST /shards/actions/failover + POST /v1/shards/actions/failover #### Example JSON body @@ -116,7 +116,7 @@ The cluster automatically manages failover to ensure high availability. Use this #### Example HTTP request - POST /shards/1/actions/failover + POST /v1/shards/1/actions/failover #### Example JSON body diff --git a/content/operate/rs/references/rest-api/requests/shards/actions/migrate.md b/content/operate/rs/references/rest-api/requests/shards/actions/migrate.md index 7c535291da..526307c6b7 100644 --- a/content/operate/rs/references/rest-api/requests/shards/actions/migrate.md +++ b/content/operate/rs/references/rest-api/requests/shards/actions/migrate.md @@ -34,7 +34,7 @@ For more information about shard migration use cases and considerations, see [Mi #### Example HTTP request - POST /shards/actions/migrate + POST /v1/shards/actions/migrate #### Example JSON body @@ -109,7 +109,7 @@ For more information about shard migration use cases and considerations, see [Mi #### Example HTTP request - POST /shards/1/actions/migrate + POST /v1/shards/1/actions/migrate #### Example JSON body diff --git a/content/operate/rs/references/rest-api/requests/shards/stats/_index.md b/content/operate/rs/references/rest-api/requests/shards/stats/_index.md index 04a8fc7186..045b9eacbf 100644 --- a/content/operate/rs/references/rest-api/requests/shards/stats/_index.md +++ b/content/operate/rs/references/rest-api/requests/shards/stats/_index.md @@ -33,7 +33,7 @@ Get statistics for all shards. #### Example HTTP request - GET /shards/stats?interval=1hour&stime=2014-08-28T10:00:00Z + GET /v1/shards/stats?interval=1hour&stime=2014-08-28T10:00:00Z #### Request headers @@ -151,7 +151,7 @@ Get statistics for a specific shard. #### Example HTTP request - GET /shards/stats/1?interval=1hour&stime=2014-08-28T10:00:00Z + GET /v1/shards/stats/1?interval=1hour&stime=2014-08-28T10:00:00Z #### Request headers diff --git a/content/operate/rs/references/rest-api/requests/shards/stats/last.md b/content/operate/rs/references/rest-api/requests/shards/stats/last.md index 3fa9bcf29e..aa8b189dcc 100644 --- a/content/operate/rs/references/rest-api/requests/shards/stats/last.md +++ b/content/operate/rs/references/rest-api/requests/shards/stats/last.md @@ -32,7 +32,7 @@ Get most recent statistics for all shards. #### Example HTTP request - GET /shards/stats/last?interval=1sec&stime=015-05-27T08:27:35Z + GET /v1/shards/stats/last?interval=1sec&stime=015-05-27T08:27:35Z #### Request headers @@ -120,7 +120,7 @@ Get most recent statistics for a specific shard. #### Example HTTP request - GET /shards/stats/last/1?interval=1sec&stime=2015-05-28T08:27:35Z + GET /v1/shards/stats/last/1?interval=1sec&stime=2015-05-28T08:27:35Z #### Request headers diff --git a/content/operate/rs/references/rest-api/requests/suffix/_index.md b/content/operate/rs/references/rest-api/requests/suffix/_index.md index 979778c4aa..ff0c952ee1 100644 --- a/content/operate/rs/references/rest-api/requests/suffix/_index.md +++ b/content/operate/rs/references/rest-api/requests/suffix/_index.md @@ -26,7 +26,7 @@ Get a single DNS suffix. #### Example HTTP request - GET /suffix/cluster.fqdn + GET /v1/suffix/cluster.fqdn #### Request headers diff --git a/content/operate/rs/references/rest-api/requests/suffixes/_index.md b/content/operate/rs/references/rest-api/requests/suffixes/_index.md index efb0d07212..3da4013e2d 100644 --- a/content/operate/rs/references/rest-api/requests/suffixes/_index.md +++ b/content/operate/rs/references/rest-api/requests/suffixes/_index.md @@ -26,7 +26,7 @@ Get all DNS suffixes in the cluster. #### Example HTTP request - GET /suffixes + GET /v1/suffixes #### Request headers diff --git a/content/operate/rs/references/rest-api/requests/users/_index.md b/content/operate/rs/references/rest-api/requests/users/_index.md index 14c6a9e847..359b8fa3b1 100644 --- a/content/operate/rs/references/rest-api/requests/users/_index.md +++ b/content/operate/rs/references/rest-api/requests/users/_index.md @@ -39,7 +39,7 @@ Get a list of all users. #### Example HTTP request ```sh -GET /users +GET /v1/users ``` #### Headers @@ -106,7 +106,7 @@ Get a single user's details. #### Example HTTP request ```sh -GET /users/1 +GET /v1/users/1 ``` #### Headers @@ -171,7 +171,7 @@ Any user can change their own name, password, or alert preferences. #### Example HTTP request ```sh -PUT /users/1 +PUT /v1/users/1 ``` #### Example JSON body @@ -264,7 +264,7 @@ Create a new user. #### Example HTTP request ```sh -POST /users +POST /v1/users ``` #### Headers @@ -412,7 +412,7 @@ Delete a user. #### Example HTTP request ```sh -DELETE /users/1 +DELETE /v1/users/1 ``` #### Headers diff --git a/content/operate/rs/references/rest-api/requests/users/authorize.md b/content/operate/rs/references/rest-api/requests/users/authorize.md index b27e199d7d..d2d2d5eb68 100644 --- a/content/operate/rs/references/rest-api/requests/users/authorize.md +++ b/content/operate/rs/references/rest-api/requests/users/authorize.md @@ -25,7 +25,7 @@ Generate a JSON Web Token (JWT) for a user to use as authorization to access the #### Example HTTP request - POST /users/authorize + POST /v1/users/authorize #### Example JSON body diff --git a/content/operate/rs/references/rest-api/requests/users/password.md b/content/operate/rs/references/rest-api/requests/users/password.md index 6b8cfcc945..2dae632652 100644 --- a/content/operate/rs/references/rest-api/requests/users/password.md +++ b/content/operate/rs/references/rest-api/requests/users/password.md @@ -27,7 +27,7 @@ Reset the password list of an internal user to include a new password. #### Example HTTP request - PUT /users/password + PUT /v1/users/password #### Example JSON body @@ -89,7 +89,7 @@ Add a new password to an internal user's passwords list. #### Example HTTP request - POST /users/password + POST /v1/users/password #### Example JSON body @@ -150,7 +150,7 @@ Delete a password from an internal user's passwords list. #### Example HTTP request - DELETE /users/password + DELETE /v1/users/password #### Example JSON body diff --git a/content/operate/rs/references/rest-api/requests/users/refresh_jwt.md b/content/operate/rs/references/rest-api/requests/users/refresh_jwt.md index 1414f28163..3b44b558a8 100644 --- a/content/operate/rs/references/rest-api/requests/users/refresh_jwt.md +++ b/content/operate/rs/references/rest-api/requests/users/refresh_jwt.md @@ -27,7 +27,7 @@ Takes a valid token and returns the new token generated by the request. #### Example HTTP request - POST /users/refresh_jwt + POST /v1/users/refresh_jwt #### Request headers