Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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<br />Values:<br />**'disabled'** <br />'snapshot'<br />'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. <br />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. <br />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:&nbsp;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:&nbsp;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`&nbsp;`/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)<br />**uid**: Unique identification of this source<br />**dns_name**: Endpoint’s DNS name<br />**port**: Endpoint’s TCP port number<br />**addr**: Endpoint’s accessible addresses<br />**proxy_policy**: The policy used for proxy binding to the endpoint<br />**exclude_proxies**: List of proxies to exclude<br />**include_proxies**: List of proxies to include<br />**addr_type**: Indicates if the endpoint is based on internal or external IPs<br /><span class="break-all">**oss_cluster_api_preferred_ip_type**</span>: Indicates preferred IP type in the OSS cluster API: internal/external<br /><span class="break-all">**oss_cluster_api_preferred_endpoint_type**</span>: 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<br />Values:<br />**'enabled'** <br />'disabled' |
Expand Down
2 changes: 1 addition & 1 deletion content/operate/rs/7.4/references/rest-api/permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 [<nobr>`PUT /users/{uid}`</nobr> 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 [<nobr>`PUT /v1/users/{uid}`</nobr> API request]({{< relref "/operate/rs/references/rest-api/requests/users#put-user" >}}) to grant necessary permissions to them.

## Roles

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ Get a single database.
#### Example HTTP request

```sh
GET /bdbs/1
GET /v1/bdbs/1
```

#### Headers
Expand Down Expand Up @@ -201,7 +201,7 @@ To track this request's progress, poll the [`/actions/<action_uid>` endpoint]({{
#### Example HTTP request

```sh
PUT /bdbs/1
PUT /v1/bdbs/1
```

#### Headers
Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -628,7 +628,7 @@ Delete an active database.
#### Example HTTP request

```sh
DELETE /bdbs/1
DELETE /v1/bdbs/1
```
#### Headers

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Initiate a database export.
#### Example HTTP request

```sh
POST /bdbs/1/actions/export
POST /v1/bdbs/1/actions/export
```

#### Headers
Expand All @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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) |

{{<note>}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
```


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Get all alert states for all databases.

#### Example HTTP request

GET /bdbs/alerts
GET /v1/bdbs/alerts

#### Request headers

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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}

Expand Down Expand Up @@ -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}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Set a single password for the bdb's default user (i.e., for `AUTH`&nbsp;`<passwo

#### Example HTTP request

PUT /bdbs/1/passwords
PUT /v1/bdbs/1/passwords

#### Example JSON body

Expand Down Expand Up @@ -95,7 +95,7 @@ Add a password to the bdb's default user (i.e., for `AUTH`&nbsp;`<password>` aut

#### Example HTTP request

POST /bdbs/1/passwords
POST /v1/bdbs/1/passwords

#### Example JSON body

Expand Down Expand Up @@ -154,7 +154,7 @@ Delete a password from the bdb's default user (i.e., for `AUTH`&nbsp;`<password>

#### Example HTTP request

DELETE /bdbs/1/passwords
DELETE /v1/bdbs/1/passwords

#### Example JSON body

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Loading