From 724c066c87909b0fd516d21c9d19b3d0224fcfa3 Mon Sep 17 00:00:00 2001 From: Andy Stark Date: Fri, 25 Sep 2026 10:09:48 +0100 Subject: [PATCH] DOC-7118 unit 2: convert rc api/cloud-integrations/context-engine to render hooks Migrates relref shortcode links and note/warning/tip/info callout shortcodes to render-hook equivalents (plain Markdown links and > [!NOTE] blockquotes) across content/operate/rc/api/, content/operate/rc/cloud-integrations/, and content/operate/rc/context-engine/. Ran build/migrate_shortcode_links.py's all-stages pass, then hand-fixed two variants the mechanical converter can't parse: a `{{}}` closing tag with a space after the slash (vercel.md), and two note callouts nested inside `1.` list items whose continuation lines lost list indentation after conversion (aws-marketplace/_index.md, gcp-marketplace/_index.md). Co-Authored-By: Claude Sonnet 5 --- content/operate/rc/api/_index.md | 28 +++++------ .../rc/api/examples/audit-system-logs.md | 4 +- .../api/examples/back-up-and-import-data.md | 24 +++++---- .../rc/api/examples/create-database.md | 34 ++++++------- .../rc/api/examples/dryrun-cost-estimates.md | 3 +- .../rc/api/examples/generate-cost-report.md | 10 ++-- .../rc/api/examples/manage-cloud-accounts.md | 2 +- .../rc/api/examples/manage-subscriptions.md | 49 +++++++++---------- content/operate/rc/api/get-started/_index.md | 28 +++++------ .../rc/api/get-started/enable-the-api.md | 9 ++-- .../rc/api/get-started/manage-api-keys.md | 9 ++-- .../rc/api/get-started/manage-tasks.md | 10 ++-- .../rc/api/get-started/process-lifecycle.md | 18 +++---- .../rc/api/get-started/use-rest-api.md | 30 +++++------- .../operate/rc/cloud-integrations/_index.md | 6 +-- .../aws-marketplace/_index.md | 7 ++- .../gcp-marketplace/_index.md | 9 ++-- .../gcp-marketplace/team-management.md | 2 +- .../operate/rc/cloud-integrations/vercel.md | 12 ++--- content/operate/rc/context-engine/_index.md | 6 +-- .../rc/context-engine/agent-memory/_index.md | 4 +- .../context-retriever/_index.md | 2 +- .../rc/context-engine/langcache/_index.md | 2 +- 23 files changed, 147 insertions(+), 161 deletions(-) diff --git a/content/operate/rc/api/_index.md b/content/operate/rc/api/_index.md index ee728f981b..001c359e88 100644 --- a/content/operate/rc/api/_index.md +++ b/content/operate/rc/api/_index.md @@ -11,7 +11,7 @@ linkTitle: REST API weight: 80 --- -The [Redis Cloud REST API]({{< relref "/operate/rc/api/api-reference" >}}) helps you manage your Redis Cloud databases programmatically. +The [Redis Cloud REST API](/content/operate/rc/api/api-reference.md) helps you manage your Redis Cloud databases programmatically. You can use the API to: @@ -22,23 +22,23 @@ You can use the API to: ## Get started -1. [Enable the API]({{< relref "/operate/rc/api/get-started/enable-the-api.md" >}}) -1. [Authenticate and authorize]({{< relref "/operate/rc/api/get-started" >}}) -1. [Create API keys]({{< relref "/operate/rc/api/get-started/manage-api-keys.md" >}}) -1. [Use the API]({{< relref "/operate/rc/api/get-started/use-rest-api.md" >}}) -1. [Learn the API lifecycle]({{< relref "/operate/rc/api/get-started/process-lifecycle.md" >}}) -1. [Create and manage subscriptions]({{< relref "/operate/rc/api/examples/manage-subscriptions.md" >}}) +1. [Enable the API](/content/operate/rc/api/get-started/enable-the-api.md) +1. [Authenticate and authorize](/content/operate/rc/api/get-started/_index.md) +1. [Create API keys](/content/operate/rc/api/get-started/manage-api-keys.md) +1. [Use the API](/content/operate/rc/api/get-started/use-rest-api.md) +1. [Learn the API lifecycle](/content/operate/rc/api/get-started/process-lifecycle.md) +1. [Create and manage subscriptions](/content/operate/rc/api/examples/manage-subscriptions.md) ## Examples -1. [Manage subscriptions]({{< relref "/operate/rc/api/examples/manage-subscriptions.md" >}}) +1. [Manage subscriptions](/content/operate/rc/api/examples/manage-subscriptions.md) 1. Database examples - - [Create and manage databases]({{< relref "/operate/rc/api/examples/create-database" >}}) - - [Back up and import data]({{< relref "/operate/rc/api/examples/back-up-and-import-data.md" >}}) -1. [Estimate costs]({{< relref "/operate/rc/api/examples/dryrun-cost-estimates.md" >}}) + - [Create and manage databases](/content/operate/rc/api/examples/create-database.md) + - [Back up and import data](/content/operate/rc/api/examples/back-up-and-import-data.md) +1. [Estimate costs](/content/operate/rc/api/examples/dryrun-cost-estimates.md) ## More info -- Use the [Redis Cloud API]({{< relref "/operate/rc/api/get-started/use-rest-api.md" >}}) -- [Full API Reference]({{< relref "/operate/rc/api/api-reference" >}}) -- Secure [authentication and authorization]({{< relref "/operate/rc/api/get-started" >}}) +- Use the [Redis Cloud API](/content/operate/rc/api/get-started/use-rest-api.md) +- [Full API Reference](/content/operate/rc/api/api-reference.md) +- Secure [authentication and authorization](/content/operate/rc/api/get-started/_index.md) diff --git a/content/operate/rc/api/examples/audit-system-logs.md b/content/operate/rc/api/examples/audit-system-logs.md index 5c028383f4..4747afd029 100644 --- a/content/operate/rc/api/examples/audit-system-logs.md +++ b/content/operate/rc/api/examples/audit-system-logs.md @@ -14,11 +14,11 @@ To view the log, sign in to the [Redis Cloud console](https://cloud.redis.io/) a {{Choose the Logs command from the Redis Cloud console menu to view your subscription system log.}} -To learn more, see [System logs]({{< relref "/operate/rc/logs-reports/system-logs" >}}). +To learn more, see [System logs](/content/operate/rc/logs-reports/system-logs.md). ## Get system logs via REST API -The REST API operation for querying the system log is [`GET /logs`]({{< relref "/operate/rc/api/api-reference#tag/Account/operation/getAccountSystemLogs" >}}). Your account must have the **Owner**, **Viewer**, or **Logs viewer** role to query this endpoint. +The REST API operation for querying the system log is [`GET /logs`](/content/operate/rc/api/api-reference.md#tag/Account/operation/getAccountSystemLogs). Your account must have the **Owner**, **Viewer**, or **Logs viewer** role to query this endpoint. The `/logs` API operation accepts the following parameters: diff --git a/content/operate/rc/api/examples/back-up-and-import-data.md b/content/operate/rc/api/examples/back-up-and-import-data.md index a9b18b3c4c..daadaf13e2 100644 --- a/content/operate/rc/api/examples/back-up-and-import-data.md +++ b/content/operate/rc/api/examples/back-up-and-import-data.md @@ -14,26 +14,25 @@ weight: 40 ## Back up a database When you create or update a database, you can specify the (optional) `periodicBackupPath` parameter -with a [backup path]({{< relref "/operate/rc/databases/back-up-data" >}}). +with a [backup path](/content/operate/rc/databases/back-up-data.md). This parameter enables periodic and on-demand backup operations for the specified database. -{{}} -The number of database backups that can run simultaneously on a cluster is limited to 4 by default. -{{}} +> [!NOTE] +> The number of database backups that can run simultaneously on a cluster is limited to 4 by default. -For Redis Cloud Pro databases, back up a database with [`POST /subscriptions/{subscriptionId}/databases/{databaseId}/backup`]({{< relref "/operate/rc/api/api-reference#tag/Databases-Pro/operation/backupDatabase" >}}). For Redis Cloud Essentials databases, use [`POST /fixed/subscriptions/{subscriptionId}/databases/{databaseId}/backup`]({{< relref "/operate/rc/api/api-reference#tag/Databases-Essentials/operation/backupDatabase_1" >}}). -On-demand database backup is an [asynchronous operation]({{< relref "/operate/rc/api/get-started/process-lifecycle" >}}). +For Redis Cloud Pro databases, back up a database with [`POST /subscriptions/{subscriptionId}/databases/{databaseId}/backup`](/content/operate/rc/api/api-reference.md#tag/Databases-Pro/operation/backupDatabase). For Redis Cloud Essentials databases, use [`POST /fixed/subscriptions/{subscriptionId}/databases/{databaseId}/backup`](/content/operate/rc/api/api-reference.md#tag/Databases-Essentials/operation/backupDatabase_1). +On-demand database backup is an [asynchronous operation](/content/operate/rc/api/get-started/process-lifecycle.md). The backup database API does not require a body. Instead, the `periodicBackupPath` must be set to a valid path with available storage capacity to store the backup files for the specific database. You can set an `adhocBackupPath` in the body to specify a different backup location for this backup. -See [Set up backup storage locations]({{< relref "/operate/rc/databases/back-up-data#set-up-backup-storage-locations" >}}) to learn how to configure your backup storage locations. +See [Set up backup storage locations](/content/operate/rc/databases/back-up-data.md#set-up-backup-storage-locations) to learn how to configure your backup storage locations. ## Import data to a database You can import data into an existing database from multiple storage sources, including AWS S3, Redis, and FTP. -Database import is an [asynchronous operation]({{< relref "/operate/rc/api/get-started/process-lifecycle" >}}). +Database import is an [asynchronous operation](/content/operate/rc/api/get-started/process-lifecycle.md). -Use [`POST /v1/subscriptions/{subscriptionId}/databases/{databaseId}/import`]({{< relref "/operate/rc/api/api-reference#tag/Databases-Pro/operation/importDatabase" >}}) to import data to an existing Redis Cloud Pro database. For Redis Cloud Essentials databases, use [`POST /fixed/subscriptions/{subscriptionId}/databases/{databaseId}/backup`]({{< relref "/operate/rc/api/api-reference#tag/Databases-Essentials/operation/importDatabase_1" >}}) +Use [`POST /v1/subscriptions/{subscriptionId}/databases/{databaseId}/import`](/content/operate/rc/api/api-reference.md#tag/Databases-Pro/operation/importDatabase) to import data to an existing Redis Cloud Pro database. For Redis Cloud Essentials databases, use [`POST /fixed/subscriptions/{subscriptionId}/databases/{databaseId}/backup`](/content/operate/rc/api/api-reference.md#tag/Databases-Essentials/operation/importDatabase_1) The requirements for data import are: @@ -44,9 +43,8 @@ The requirements for data import are: The duration of the import process depends on the amount of data imported and the network bandwidth between the data source and the importing database. -{{< warning >}} -Data imported into an existing database overwrites any existing data. -{{< /warning >}} +> [!WARNING] +> Data imported into an existing database overwrites any existing data. You can specify the backup location with the `sourceType` and `importFromUri` values for these sources: @@ -59,4 +57,4 @@ You can specify the backup location with the `sourceType` and `importFromUri` va |Redis server|redis|redis://[db_password]@[host]:[port]| |Web server|HTTP|HTTP://[username][:password]@[:port]/[path/]filename.rdb[.gz]| -See [Import data]({{< relref "/operate/rc/databases/import-data" >}}) to learn how to set up your storage locations for data import. +See [Import data](/content/operate/rc/databases/import-data.md) to learn how to set up your storage locations for data import. diff --git a/content/operate/rc/api/examples/create-database.md b/content/operate/rc/api/examples/create-database.md index afb011f464..16720821a8 100644 --- a/content/operate/rc/api/examples/create-database.md +++ b/content/operate/rc/api/examples/create-database.md @@ -16,9 +16,9 @@ You can use the Redis Cloud REST API to create and manage databases. ### Create an Essentials database -To create a Redis Cloud Essentials database, use [`POST /fixed/subscriptions/{subscriptionId}/databases`]({{< relref "/operate/rc/api/api-reference#tag/Databases-Essentials/operation/createFixedDatabase" >}}). +To create a Redis Cloud Essentials database, use [`POST /fixed/subscriptions/{subscriptionId}/databases`](/content/operate/rc/api/api-reference.md#tag/Databases-Essentials/operation/createFixedDatabase). -This call creates a database in the specified subscription. Use [`GET /fixed/subscriptions`]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Essentials/operation/getAllSubscriptions_1" >}}) to get a list of Essentials subscriptions and their IDs. +This call creates a database in the specified subscription. Use [`GET /fixed/subscriptions`](/content/operate/rc/api/api-reference.md#tag/Subscriptions-Essentials/operation/getAllSubscriptions_1) to get a list of Essentials subscriptions and their IDs. ```shell POST "https://[host]/v1/fixed/subscriptions/{subscriptionId}/databases" @@ -31,31 +31,31 @@ This example JSON body contains only the most basic, required parameters to crea - `name`: The database name. A unique name per subscription that can contain only alphanumeric characters and hyphens -There are other additional parameters and settings that can be defined on database creation. Review the database parameters and options in the [full API reference]({{< relref "/operate/rc/api/api-reference#tag/Databases-Essentials/operation/createFixedDatabase" >}}). +There are other additional parameters and settings that can be defined on database creation. Review the database parameters and options in the [full API reference](/content/operate/rc/api/api-reference.md#tag/Databases-Essentials/operation/createFixedDatabase). -Some options may not be compatible with your selected plan. Use [`GET /fixed/subscriptions/{subscriptionId}`]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Essentials/operation/getFixedSubscriptionsPlansBySubscriptionId" >}}) to view the plan you have selected and what options it supports. +Some options may not be compatible with your selected plan. Use [`GET /fixed/subscriptions/{subscriptionId}`](/content/operate/rc/api/api-reference.md#tag/Subscriptions-Essentials/operation/getFixedSubscriptionsPlansBySubscriptionId) to view the plan you have selected and what options it supports. -The response body contains the `taskId` for the task that creates the database. You can use [`GET /v1/tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}) to track the task's status. +The response body contains the `taskId` for the task that creates the database. You can use [`GET /v1/tasks/{taskId}`](/content/operate/rc/api/api-reference.md#tag/Tasks/operation/getTaskById) to track the task's status. ### Update an Essentials database -To update a Redis Cloud Essentials database, use [`PUT /fixed/subscriptions/{subscriptionId}/databases/{databaseId}`]({{< relref "/operate/rc/api/api-reference#tag/Databases-Essentials/operation/deleteFixedDatabaseByID" >}}). +To update a Redis Cloud Essentials database, use [`PUT /fixed/subscriptions/{subscriptionId}/databases/{databaseId}`](/content/operate/rc/api/api-reference.md#tag/Databases-Essentials/operation/deleteFixedDatabaseByID). -The primary component of a database update request is the JSON request body that contains the details of the requested database changes. You can see the full set of changes you can make in the [full API reference]({{< relref "/operate/rc/api/api-reference#tag/Databases-Essentials/operation/deleteFixedDatabaseByID" >}}). +The primary component of a database update request is the JSON request body that contains the details of the requested database changes. You can see the full set of changes you can make in the [full API reference](/content/operate/rc/api/api-reference.md#tag/Databases-Essentials/operation/deleteFixedDatabaseByID). -Some options may not be compatible with your selected plan. Use [`GET /fixed/subscriptions/{subscriptionId}`]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Essentials/operation/getFixedSubscriptionsPlansBySubscriptionId" >}}) to view the plan you have selected and what options it supports. +Some options may not be compatible with your selected plan. Use [`GET /fixed/subscriptions/{subscriptionId}`](/content/operate/rc/api/api-reference.md#tag/Subscriptions-Essentials/operation/getFixedSubscriptionsPlansBySubscriptionId) to view the plan you have selected and what options it supports. -The response body contains the `taskId` for the task that updates the database. You can use [`GET /v1/tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}) to track the task's status. +The response body contains the `taskId` for the task that updates the database. You can use [`GET /v1/tasks/{taskId}`](/content/operate/rc/api/api-reference.md#tag/Tasks/operation/getTaskById) to track the task's status. ## Redis Cloud Pro ### Create a Pro database -If you want to create a Pro database in a new subscription, see [Create a Pro subscription]({{< relref "/operate/rc/api/examples/manage-subscriptions#create-a-pro-subscription" >}}). +If you want to create a Pro database in a new subscription, see [Create a Pro subscription](/content/operate/rc/api/examples/manage-subscriptions.md#create-a-pro-subscription). -To create a Redis Cloud Pro database in an existing subscription, use [`POST /subscriptions/{subscriptionId}/databases`]({{< relref "/operate/rc/api/api-reference#tag/Databases-Pro/operation/createDatabase" >}}). +To create a Redis Cloud Pro database in an existing subscription, use [`POST /subscriptions/{subscriptionId}/databases`](/content/operate/rc/api/api-reference.md#tag/Databases-Pro/operation/createDatabase). -This call creates a database in the specified subscription. Use [`GET /subscriptions`]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Pro/operation/getAllSubscriptions" >}}) to get a list of subscriptions and their IDs. +This call creates a database in the specified subscription. Use [`GET /subscriptions`](/content/operate/rc/api/api-reference.md#tag/Subscriptions-Pro/operation/getAllSubscriptions) to get a list of subscriptions and their IDs. ```shell POST "https://[host]/v1/subscriptions/{subscriptionId}/databases" @@ -70,14 +70,14 @@ This example JSON body contains only the most basic, required parameters to crea - `name`: The database name. A unique name per subscription that can contain only alphanumeric characters and hyphens - `datasetSizeInGb`: Maximum dataset size in GB -There are many additional parameters and settings that can be defined on database creation. Review the database parameters and options in the [full API reference]({{< relref "/operate/rc/api/api-reference#tag/Databases-Pro/operation/createDatabase" >}}). +There are many additional parameters and settings that can be defined on database creation. Review the database parameters and options in the [full API reference](/content/operate/rc/api/api-reference.md#tag/Databases-Pro/operation/createDatabase). -The response body contains the `taskId` for the task that creates the database. You can use [`GET /v1/tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}) to track the task's status. +The response body contains the `taskId` for the task that creates the database. You can use [`GET /v1/tasks/{taskId}`](/content/operate/rc/api/api-reference.md#tag/Tasks/operation/getTaskById) to track the task's status. ### Update a Redis Cloud Pro database -To update a Redis Cloud Pro database, use [`PUT /subscriptions/{subscriptionId}/databases/{databaseId}`]({{< relref "/operate/rc/api/api-reference#tag/Databases-Pro/operation/updateDatabase" >}}). +To update a Redis Cloud Pro database, use [`PUT /subscriptions/{subscriptionId}/databases/{databaseId}`](/content/operate/rc/api/api-reference.md#tag/Databases-Pro/operation/updateDatabase). -The primary component of a database update request is the JSON request body that contains the details of the requested database changes. You can see the full set of changes you can make in the [full API reference]({{< relref "/operate/rc/api/api-reference#tag/Databases-Pro/operation/updateDatabase" >}}). +The primary component of a database update request is the JSON request body that contains the details of the requested database changes. You can see the full set of changes you can make in the [full API reference](/content/operate/rc/api/api-reference.md#tag/Databases-Pro/operation/updateDatabase). -The response body contains the `taskId` for the task that updates the database. You can use [`GET /v1/tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}) to track the task's status. \ No newline at end of file +The response body contains the `taskId` for the task that updates the database. You can use [`GET /v1/tasks/{taskId}`](/content/operate/rc/api/api-reference.md#tag/Tasks/operation/getTaskById) to track the task's status. \ No newline at end of file diff --git a/content/operate/rc/api/examples/dryrun-cost-estimates.md b/content/operate/rc/api/examples/dryrun-cost-estimates.md index 0b3b283c3f..3dc8369759 100644 --- a/content/operate/rc/api/examples/dryrun-cost-estimates.md +++ b/content/operate/rc/api/examples/dryrun-cost-estimates.md @@ -216,7 +216,8 @@ Here is an example of the pricing response section for the above create subscrip } ``` -{{}}Some of the response content was omitted for brevity.{{}} +> [!NOTE] +> Some of the response content was omitted for brevity. 1. The `pricing` array contains an element for each database, containing the database name and cost evaluation related to that database 2. The database cost is measured in type and number of shards required for the specific database, as defined by the database template in the request. See [Cloud Pricing](https://redislabs.com/redis-enterprise-cloud/pricing) diff --git a/content/operate/rc/api/examples/generate-cost-report.md b/content/operate/rc/api/examples/generate-cost-report.md index aa3972b06e..2b62a4bd5c 100644 --- a/content/operate/rc/api/examples/generate-cost-report.md +++ b/content/operate/rc/api/examples/generate-cost-report.md @@ -18,7 +18,7 @@ The following sections provide examples for each step. ## Generate a cost report -To generate a cost report, use [`POST /cost-report`]({{< relref "/operate/rc/api/api-reference#tag/Account/operation/createCostReport" >}}). Your account must have the **Owner**, **Billing admin**, or **Viewer** role to generate a cost report through this endpoint. +To generate a cost report, use [`POST /cost-report`](/content/operate/rc/api/api-reference.md#tag/Account/operation/createCostReport). Your account must have the **Owner**, **Billing admin**, or **Viewer** role to generate a cost report through this endpoint. Include `startDate` and `endDate` in your request body using `YYYY-MM-DD` format. You can specify a date range up to 40 days. @@ -38,7 +38,7 @@ More options and filters can be added to the request body to filter the report d | `databaseIds` | Array of integers | Filters the report to only include the specified databases. | | `subscriptionType` | Enum: `essentials`, `pro` | Filters the report to only include subscriptions of the specified type. | | `regions` | Array of strings | Filters the report to only include subscriptions in the specified regions. | -| `tags` | Array of key-value pairs | Filters the report to only include databases with the specified [tags]({{< relref "/operate/rc/databases/tag-database" >}}). Both `key` and `value` are required for each tag. | +| `tags` | Array of key-value pairs | Filters the report to only include databases with the specified [tags](/content/operate/rc/databases/tag-database.md). Both `key` and `value` are required for each tag. | For example, the following request body generates a CSV report for all databases in the `us-east-1` region that have the `team:marketing` tag in January 2025: @@ -57,7 +57,7 @@ For example, the following request body generates a CSV report for all databases } ``` -The response body is a [task object]({{< relref "/operate/rc/api/get-started/manage-tasks#task-information" >}}) that contains the `taskId` for the task that generates the cost report: +The response body is a [task object](/content/operate/rc/api/get-started/manage-tasks.md#task-information) that contains the `taskId` for the task that generates the cost report: ```json { @@ -78,7 +78,7 @@ The response body is a [task object]({{< relref "/operate/rc/api/get-started/man ## Get cost report status -To get the status of the cost report generation, use [`GET /tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}) with the `taskId` from the previous step. +To get the status of the cost report generation, use [`GET /tasks/{taskId}`](/content/operate/rc/api/api-reference.md#tag/Tasks/operation/getTaskById) with the `taskId` from the previous step. When the report is ready, the `status` is `processing-completed` and the `response` field contains a `costReportId`: @@ -106,7 +106,7 @@ When the report is ready, the `status` is `processing-completed` and the `respon ## Download cost report -To get the cost report, use [`GET /cost-report/{costReportId}`]({{< relref "/operate/rc/api/api-reference#tag/Account/operation/getCostReport" >}}) with the `costReportId` from the previous step. +To get the cost report, use [`GET /cost-report/{costReportId}`](/content/operate/rc/api/api-reference.md#tag/Account/operation/getCostReport) with the `costReportId` from the previous step. You can use this cost report with any FOCUS-compatible cost reporting tool to analyze and visualize your costs. diff --git a/content/operate/rc/api/examples/manage-cloud-accounts.md b/content/operate/rc/api/examples/manage-cloud-accounts.md index 0a67bd6530..f560857894 100644 --- a/content/operate/rc/api/examples/manage-cloud-accounts.md +++ b/content/operate/rc/api/examples/manage-cloud-accounts.md @@ -15,7 +15,7 @@ draft: true You can use the Redis Cloud REST API to create and manage cloud accounts. -These examples use the [`cURL` utility]({{< relref "/operate/rc/api/get-started/use-rest-api#use-the-curl-http-client" >}}); you can use any REST client to work with the Redis Cloud REST API. +These examples use the [`cURL` utility](/content/operate/rc/api/get-started/use-rest-api.md#use-the-curl-http-client); you can use any REST client to work with the Redis Cloud REST API. ## Create a cloud account diff --git a/content/operate/rc/api/examples/manage-subscriptions.md b/content/operate/rc/api/examples/manage-subscriptions.md index 4d19f91e43..f7fe8c92e8 100644 --- a/content/operate/rc/api/examples/manage-subscriptions.md +++ b/content/operate/rc/api/examples/manage-subscriptions.md @@ -15,7 +15,7 @@ The Redis Cloud REST API lets you create and manage all kinds of subscriptions. ### Create an Essentials subscription -Use [`POST /v1/fixed/subscriptions`]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Essentials/operation/createSubscription_1" >}}) to create an Essentials subscription. +Use [`POST /v1/fixed/subscriptions`](/content/operate/rc/api/api-reference.md#tag/Subscriptions-Essentials/operation/createSubscription_1) to create an Essentials subscription. ```sh POST "https://[host]/v1/fixed/subscriptions" @@ -30,27 +30,26 @@ Modify the following parameters in the sample JSON document to create a subscrip - **`paymentMethodId`** - Specify a payment method connected to your account. - Use [`GET /v1/payment-methods`]({{< relref "/operate/rc/api/api-reference#tag/Account/operation/getAccountPaymentMethods" >}}) to find a payment method ID. + Use [`GET /v1/payment-methods`](/content/operate/rc/api/api-reference.md#tag/Account/operation/getAccountPaymentMethods) to find a payment method ID. You don't need to pass this field in your API request if you subscribed to Redis Cloud through a marketplace integration. - **`planId`** - Specify an essentials plan to create. - Use [`GET /v1/fixed/plans`]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Essentials/operation/getAllFixedSubscriptionsPlans" >}}) to get a list of plan IDs. + Use [`GET /v1/fixed/plans`](/content/operate/rc/api/api-reference.md#tag/Subscriptions-Essentials/operation/getAllFixedSubscriptionsPlans) to get a list of plan IDs. -After you create an Essentials subscription, you must use the [`POST /v1/fixed/subscriptions/{subscriptionId}/databases`]({{< relref "/operate/rc/api/api-reference#tag/Databases-Essentials/operation/createFixedDatabase" >}}) endpoint to [create the database]({{< relref "/operate/rc/api/examples/create-database#redis-cloud-essentials" >}}). +After you create an Essentials subscription, you must use the [`POST /v1/fixed/subscriptions/{subscriptionId}/databases`](/content/operate/rc/api/api-reference.md#tag/Databases-Essentials/operation/createFixedDatabase) endpoint to [create the database](/content/operate/rc/api/examples/create-database.md#redis-cloud-essentials). -You can include the contents of the JSON document in the `POST /v1/fixed/subscriptions` operation in the [Swagger UI](https://api.redislabs.com/v1/swagger-ui.html). See [Swagger user interface]({{< relref "/operate/rc/api/get-started/use-rest-api#swagger-user-interface" >}}) for more details. +You can include the contents of the JSON document in the `POST /v1/fixed/subscriptions` operation in the [Swagger UI](https://api.redislabs.com/v1/swagger-ui.html). See [Swagger user interface](/content/operate/rc/api/get-started/use-rest-api.md#swagger-user-interface) for more details. -{{< note >}} -The Swagger UI generates default JSON examples for `POST` and `PUT` operations. You can reference these examples and modify them to fit your specific needs and account settings. The examples will fail if used as-is. -{{< /note >}} +> [!NOTE] +> The Swagger UI generates default JSON examples for `POST` and `PUT` operations. You can reference these examples and modify them to fit your specific needs and account settings. The examples will fail if used as-is. -The response body contains the `taskId` for the task that creates the subscription. You can use [`GET /v1/tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}) to track the task's status. +The response body contains the `taskId` for the task that creates the subscription. You can use [`GET /v1/tasks/{taskId}`](/content/operate/rc/api/api-reference.md#tag/Tasks/operation/getTaskById) to track the task's status. ### Update an Essentials subscription -Use [`PUT /v1/fixed/subscriptions/{subscriptionId}`]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Essentials/operation/updateSubscription_1" >}}) to update an Essentials subscription. +Use [`PUT /v1/fixed/subscriptions/{subscriptionId}`](/content/operate/rc/api/api-reference.md#tag/Subscriptions-Essentials/operation/updateSubscription_1) to update an Essentials subscription. ```sh PUT "https://[host]/v1/fixed/subscriptions/{subscriptionId}" @@ -70,30 +69,30 @@ You can only change the following settings with this endpoint: - Is in the same cloud provider and region of your current plan. - - Has a compatible [High-availability option]({{< relref "/operate/rc/databases/configuration/high-availability" >}}) to your current plan. For example, if your current plan has single-zone replication, you cannot switch to a plan with multi-zone replication, but you can switch to a plan with no replication. If your current plan has multi-zone replication, you must switch to a plan with multi-zone replication. + - Has a compatible [High-availability option](/content/operate/rc/databases/configuration/high-availability.md) to your current plan. For example, if your current plan has single-zone replication, you cannot switch to a plan with multi-zone replication, but you can switch to a plan with no replication. If your current plan has multi-zone replication, you must switch to a plan with multi-zone replication. - Use [`GET /v1/fixed/plans/subscriptions/{subscriptionID}`]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Essentials/operation/getFixedSubscriptionsPlanById" >}}) to get a list of plan IDs that are compatible with your subscription. + Use [`GET /v1/fixed/plans/subscriptions/{subscriptionID}`](/content/operate/rc/api/api-reference.md#tag/Subscriptions-Essentials/operation/getFixedSubscriptionsPlanById) to get a list of plan IDs that are compatible with your subscription. - **`paymentMethodId`** - Specify a different payment method connected to your account. - Use [`GET /v1/payment-methods`]({{< relref "/operate/rc/api/api-reference#tag/Account/operation/getAccountPaymentMethods" >}}) to find a payment method ID. + Use [`GET /v1/payment-methods`](/content/operate/rc/api/api-reference.md#tag/Account/operation/getAccountPaymentMethods) to find a payment method ID. -The response body contains the `taskId` for the task that updates the subscription. You can use [`GET /v1/tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}) to track the task's status. +The response body contains the `taskId` for the task that updates the subscription. You can use [`GET /v1/tasks/{taskId}`](/content/operate/rc/api/api-reference.md#tag/Tasks/operation/getTaskById) to track the task's status. ### Delete an Essentials subscription -Use [`DELETE /v1/fixed/subscriptions/{subscriptionId}`]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Essentials/operation/deleteSubscriptionById_1" >}}) to delete a subscription. +Use [`DELETE /v1/fixed/subscriptions/{subscriptionId}`](/content/operate/rc/api/api-reference.md#tag/Subscriptions-Essentials/operation/deleteSubscriptionById_1) to delete a subscription. ```sh DELETE "https://[host]/v1/fixed/subscriptions/{subscriptionId}" ``` -The response body contains the `taskId` for the task that deletes the subscription. You can use [`GET /v1/tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}) to track the task's status. +The response body contains the `taskId` for the task that deletes the subscription. You can use [`GET /v1/tasks/{taskId}`](/content/operate/rc/api/api-reference.md#tag/Tasks/operation/getTaskById) to track the task's status. ## Redis Cloud Pro ### Create a Pro subscription -Use [`POST /v1/subscriptions`]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Pro/operation/createSubscription" >}}) to create a Pro subscription. +Use [`POST /v1/subscriptions`](/content/operate/rc/api/api-reference.md#tag/Subscriptions-Pro/operation/createSubscription) to create a Pro subscription. ```sh POST "https://[host]/v1/subscriptions" @@ -127,19 +126,19 @@ Modify the following parameters in the sample JSON document to create a subscrip - **`paymentMethodId`** - Specify a payment method connected to your account. - Use [`GET /v1/payment-methods`]({{< relref "/operate/rc/api/api-reference#tag/Account/operation/getAccountPaymentMethods" >}}) to find a payment method ID. + Use [`GET /v1/payment-methods`](/content/operate/rc/api/api-reference.md#tag/Account/operation/getAccountPaymentMethods) to find a payment method ID. You don't need to pass this field in your API request if you subscribed to Redis Cloud through a marketplace integration. The request JSON body contains two primary segments: subscription specification and databases specification. When you create a subscription, you must specify one or more databases in the "`databases`" array. -There are many additional parameters and settings that can be defined on subscription and database creation. Review the subscription parameters and options in the [Full API documentation]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Pro/operation/createSubscription" >}}). +There are many additional parameters and settings that can be defined on subscription and database creation. Review the subscription parameters and options in the [Full API documentation](/content/operate/rc/api/api-reference.md#tag/Subscriptions-Pro/operation/createSubscription). -The response body contains the `taskId` for the task that creates the subscription. You can use [`GET /v1/tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}) to track the task's status. +The response body contains the `taskId` for the task that creates the subscription. You can use [`GET /v1/tasks/{taskId}`](/content/operate/rc/api/api-reference.md#tag/Tasks/operation/getTaskById) to track the task's status. ### Update a Pro subscription -Use [`PUT /v1/subscriptions/{subscriptionId}`]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Pro/operation/updateSubscription" >}}) to update a Pro subscription. +Use [`PUT /v1/subscriptions/{subscriptionId}`](/content/operate/rc/api/api-reference.md#tag/Subscriptions-Pro/operation/updateSubscription) to update a Pro subscription. ```sh PUT "https://[host]/v1/subscriptions/{subscriptionId}" @@ -154,15 +153,15 @@ You can only change the following settings with this endpoint: - **`paymentMethodId`** - Specify a different payment method connected to your account. - Use [`GET /v1/payment-methods`]({{< relref "/operate/rc/api/api-reference#tag/Account/operation/getAccountPaymentMethods" >}}) to find a payment method ID. + Use [`GET /v1/payment-methods`](/content/operate/rc/api/api-reference.md#tag/Account/operation/getAccountPaymentMethods) to find a payment method ID. -The response body contains the `taskId` for the task that updates the subscription. You can use [`GET /v1/tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}) to track the task's status. +The response body contains the `taskId` for the task that updates the subscription. You can use [`GET /v1/tasks/{taskId}`](/content/operate/rc/api/api-reference.md#tag/Tasks/operation/getTaskById) to track the task's status. ### Delete a Pro subscription -Use [`DELETE /v1/subscriptions/{subscriptionId}`]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Pro/operation/deleteSubscriptionById" >}}) to delete a subscription. +Use [`DELETE /v1/subscriptions/{subscriptionId}`](/content/operate/rc/api/api-reference.md#tag/Subscriptions-Pro/operation/deleteSubscriptionById) to delete a subscription. ```sh DELETE "https://[host]/v1/subscriptions/{subscriptionId}" ``` -The response body contains the `taskId` for the task that deletes the subscription. You can use [`GET /v1/tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}) to track the task's status. +The response body contains the `taskId` for the task that deletes the subscription. You can use [`GET /v1/tasks/{taskId}`](/content/operate/rc/api/api-reference.md#tag/Tasks/operation/getTaskById) to track the task's status. diff --git a/content/operate/rc/api/get-started/_index.md b/content/operate/rc/api/get-started/_index.md index b0be693299..03504d2d9a 100644 --- a/content/operate/rc/api/get-started/_index.md +++ b/content/operate/rc/api/get-started/_index.md @@ -28,15 +28,14 @@ To use the keys to authenticate and authorize your request, include the keys wit ## Enable the API -The API is disabled on all accounts by default. You must [enable the API]({{< relref "/operate/rc/api/get-started/enable-the-api" >}}) before you can use it. +The API is disabled on all accounts by default. You must [enable the API](/content/operate/rc/api/get-started/enable-the-api.md) before you can use it. ## Account key The account key identifies your specific account when you perform an API request. This is the account responsible for your subscription. -{{< note >}} -An account key is an account-level secret. Do not share this key with anyone not authorized to use the account. -{{< /note >}} +> [!NOTE] +> An account key is an account-level secret. Do not share this key with anyone not authorized to use the account. You create the account key once when enabling API access. @@ -46,24 +45,23 @@ If you need to change or delete your account key, please [contact support](https The user key is a personal key that belongs to a specific user having the **Owner**, **Viewer**, **Billing admin**, or **Logs viewer** role. User keys are assigned to users when they're created. Keys can belong to only one user; however, a user may have multiple keys. -You can view keys or copy their values _only_ during the [creation process]({{< relref "/operate/rc/api/get-started/manage-api-keys" >}}). +You can view keys or copy their values _only_ during the [creation process](/content/operate/rc/api/get-started/manage-api-keys.md). -{{< note >}} -User keys are personal secrets. Do not share them. -{{< /note >}} +> [!NOTE] +> User keys are personal secrets. Do not share them. -Individual owners can [generate multiple user keys]({{< relref "/operate/rc/api/get-started/manage-api-keys" >}}) +Individual owners can [generate multiple user keys](/content/operate/rc/api/get-started/manage-api-keys.md) for themselves, for separate apps, or for other owners, viewers, or log viewers within the same account. Use key names to uniquely associate specific API requests to individual users or apps. -Doing so lets you [audit API requests]({{< relref "/operate/rc/api/examples/audit-system-logs" >}}) using the system log, which tracks the key used to authenticate each request. +Doing so lets you [audit API requests](/content/operate/rc/api/examples/audit-system-logs.md) using the system log, which tracks the key used to authenticate each request. ## Authentication using API keys Every API request must use the **account key** and a **user key** to authenticate. -The keys are provided as [HTTP request headers]({{< relref "/operate/rc/api/get-started/use-rest-api#use-the-curl-http-client" >}}), shown earlier. +The keys are provided as [HTTP request headers](/content/operate/rc/api/get-started/use-rest-api.md#use-the-curl-http-client), shown earlier. ## Authenticate a request @@ -73,12 +71,12 @@ An API request successfully authenticates when: 1. The user key is associated with the same account as the account key. 1. The request originates from a valid source IP address, as defined in a [CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) allow list associated with the user key. - This requirement applies when you've [defined a CIDR allow list]({{< relref "/operate/rc/api/get-started/manage-api-keys#manage-cidr-allow-list" >}}) for the secret key. + This requirement applies when you've [defined a CIDR allow list](/content/operate/rc/api/get-started/manage-api-keys.md#manage-cidr-allow-list) for the secret key. ## More info To learn more, see: -- [Manage API keys]({{< relref "/operate/rc/api/get-started/manage-api-keys" >}}) -- [Use the API]({{< relref "/operate/rc/api/get-started/use-rest-api" >}}) -- [Full API reference]({{< relref "/operate/rc/api/api-reference" >}}) +- [Manage API keys](/content/operate/rc/api/get-started/manage-api-keys.md) +- [Use the API](/content/operate/rc/api/get-started/use-rest-api.md) +- [Full API reference](/content/operate/rc/api/api-reference.md) diff --git a/content/operate/rc/api/get-started/enable-the-api.md b/content/operate/rc/api/get-started/enable-the-api.md index d8acb5abc7..6b57d1dea1 100644 --- a/content/operate/rc/api/get-started/enable-the-api.md +++ b/content/operate/rc/api/get-started/enable-the-api.md @@ -29,12 +29,11 @@ To enable the API: {{Use the **Enable API** button to enable the REST API for your account.}} -To authenticate REST API calls, you need to use both the API account key and an [API user key]({{< relref "/operate/rc/api/get-started/manage-api-keys#api-user-keys" >}}) to make API calls. +To authenticate REST API calls, you need to use both the API account key and an [API user key](/content/operate/rc/api/get-started/manage-api-keys.md#api-user-keys) to make API calls. Only account owners can see the access key in the account settings and give API access to other users. -{{< warning >}} -Make sure that you keep your access keys secret. Anyone who sends an API request with a valid access key can make changes to your account. -{{< /warning >}} +> [!WARNING] +> Make sure that you keep your access keys secret. Anyone who sends an API request with a valid access key can make changes to your account. -To manage your API keys or to limit IP addresses for user keys, see [Manage API keys]({{< relref "/operate/rc/api/get-started/manage-api-keys.md" >}}). +To manage your API keys or to limit IP addresses for user keys, see [Manage API keys](/content/operate/rc/api/get-started/manage-api-keys.md). diff --git a/content/operate/rc/api/get-started/manage-api-keys.md b/content/operate/rc/api/get-started/manage-api-keys.md index 0f3f950856..68c2e9705d 100644 --- a/content/operate/rc/api/get-started/manage-api-keys.md +++ b/content/operate/rc/api/get-started/manage-api-keys.md @@ -23,7 +23,7 @@ Use the **API Keys** tab of the **Access Management** screen to manage your keys {{Use the **API Keys** tab of the **Access Management** screen to manage your REST API keys.}} -If an **Enable API** button appears, select it to [enable the REST API]({{< relref "/operate/rc/api/get-started/enable-the-api.md" >}}) for your account. +If an **Enable API** button appears, select it to [enable the REST API](/content/operate/rc/api/get-started/enable-the-api.md) for your account. {{Use the **Enable API** button to enable the REST API for your account.}} @@ -72,10 +72,9 @@ When you do this, the **API user key** dialog appears. {{The **API user key** dialog lets you copy the value of the new key to the Clipboard.}}
-{{}} -This is the only time the value of the user key is available. Save it to a secure location before closing the dialog box.

-If you lose the user key value, it cannot be retrieved. If this happens, create a new key to replace the lost one. -{{}} +> [!WARNING] +> This is the only time the value of the user key is available. Save it to a secure location before closing the dialog box.

+> If you lose the user key value, it cannot be retrieved. If this happens, create a new key to replace the lost one. The **Finish** button is inactive until you copy the key to the clipboard. After you save the user key, you can also select **Copy account key** to save the account key. diff --git a/content/operate/rc/api/get-started/manage-tasks.md b/content/operate/rc/api/get-started/manage-tasks.md index 524f3c046d..9a1b14e5a8 100644 --- a/content/operate/rc/api/get-started/manage-tasks.md +++ b/content/operate/rc/api/get-started/manage-tasks.md @@ -22,7 +22,7 @@ All create, update, and delete API operations (`POST`, `PUT`, and `DELETE`) and After you request an asynchronous operation, the operation returns a `taskId` that identities the specific task, and contains contextual and status data on the API operation performed by the task. -Tasks are part of the API [processing and provisioning lifecycle]({{< relref "/operate/rc/api/get-started/process-lifecycle" >}}). +Tasks are part of the API [processing and provisioning lifecycle](/content/operate/rc/api/get-started/process-lifecycle.md). ## Task information @@ -49,7 +49,7 @@ Where: - `taskId` - The unique identifier (UUID) of the specific task - `commandType` - The request (command) type -- `status` - The [status]({{< relref "/operate/rc/api/get-started/process-lifecycle#task-process-states" >}}) of the task +- `status` - The [status](/content/operate/rc/api/get-started/process-lifecycle.md#task-process-states) of the task - `description` - A description of the status - `timestamp` - The time of the response in ISO-8601 date format and in the UTC timezone - `_links` - URI links to resources related to the task including: @@ -62,7 +62,7 @@ With the task ID, you can query the task status for updates and progress informa The response in the above example shows a URL with the title `getTaskStatusUpdates`. The URL in the `href` property returns updates for the specified task. -Use [`GET /v1/tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}) to check the task status. +Use [`GET /v1/tasks/{taskId}`](/content/operate/rc/api/api-reference.md#tag/Tasks/operation/getTaskById) to check the task status. This endpoint returns information about the queried task. @@ -95,11 +95,11 @@ This response example shows: - The `status` value is `"processing-completed"`. - The `response` field contains the resource identifier of the subscription resource changed by this task. - The `links` array contains another `getSubscriptionInformation` URL that links to the newly created subscription. - This link queries the subscription status during [provisioning]({{< relref "/operate/rc/api/get-started/process-lifecycle.md" >}})) + This link queries the subscription status during [provisioning](/content/operate/rc/api/get-started/process-lifecycle.md)) ### Tasks list -You can use the API operation [`GET /tasks`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getAllTasks" >}}) to list the recently submitted and completed tasks for the current account. +You can use the API operation [`GET /tasks`](/content/operate/rc/api/api-reference.md#tag/Tasks/operation/getAllTasks) to list the recently submitted and completed tasks for the current account. This API operation returns a list of tasks for the current account, sorted by most recent status update. diff --git a/content/operate/rc/api/get-started/process-lifecycle.md b/content/operate/rc/api/get-started/process-lifecycle.md index 31b3a237d2..e5be8ab52e 100644 --- a/content/operate/rc/api/get-started/process-lifecycle.md +++ b/content/operate/rc/api/get-started/process-lifecycle.md @@ -12,7 +12,7 @@ weight: 60 --- Redis Cloud owners and viewers can leverage a REST API that permits operations against a variety of resources, including subscriptions, databases, and related infrastructure. -[Once it's enabled]({{< relref "/operate/rc/api/get-started/enable-the-api.md" >}}), you can use the REST API to create, update, and delete subscriptions, databases, and other entities. +[Once it's enabled](/content/operate/rc/api/get-started/enable-the-api.md), you can use the REST API to create, update, and delete subscriptions, databases, and other entities. All create, update, and delete API operations (`POST`, `PUT`, and `DELETE`) and some query operations (`GET`) run asynchronously, which means that provisioning or processing occurs in the background. When you submit a request, a background process, known as a **Task**, starts working on it. The response object includes an ID that lets you determine the status of the background process as it works. @@ -30,9 +30,9 @@ During this phase, the request is received, evaluated, planned, and executed. The response objects for all asynchronous operations provide a `taskId` identifier that lets you track the progress of the underlying operation. -You can query the `taskId` to track the state of a specific task using [`GET /v1/tasks/{taskId}`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getTaskById" >}}). +You can query the `taskId` to track the state of a specific task using [`GET /v1/tasks/{taskId}`](/content/operate/rc/api/api-reference.md#tag/Tasks/operation/getTaskById). -You can also query the state of all active tasks or recently completed tasks in your account using [`GET /tasks`]({{< relref "/operate/rc/api/api-reference#tag/Tasks/operation/getAllTasks" >}}). +You can also query the state of all active tasks or recently completed tasks in your account using [`GET /tasks`](/content/operate/rc/api/api-reference.md#tag/Tasks/operation/getAllTasks). ### Task process states @@ -46,22 +46,20 @@ During the processing of a request, the task moves through these states: - `processing-error` - Request processing failed. A detailed cause or reason is included in the task status JSON response. -{{< note >}} -A task that reaches the `received` state cannot be cancelled and it will await completion (i.e. processing and provisioning). If you wish to undo an operation that was performed by a task, perform a compensating action (for example: delete a subscription that was created unintentionally) -{{< /note >}} +> [!NOTE] +> A task that reaches the `received` state cannot be cancelled and it will await completion (i.e. processing and provisioning). If you wish to undo an operation that was performed by a task, perform a compensating action (for example: delete a subscription that was created unintentionally) ## Task provisioning phase When the processing phase succeeds and the task is in the `processing-completed` state, the provisioning phase starts. During the provisioning phase, the API orchestrates all of the infrastructure, resources, and dependencies required by the request. -{{< note >}} -The term "provisioning" refers to all infrastructure changes required in order to apply the request. This includes provisioning new or additional infrastructure. -{{< /note >}} +> [!NOTE] +> The term "provisioning" refers to all infrastructure changes required in order to apply the request. This includes provisioning new or additional infrastructure. The provisioning phase may require several minutes to complete. You can query the resource identifier to track the progress of the provisioning phase. -For example, when you provision a new subscription, use [`GET /v1/subscriptions/{subscriptionId}`]({{< relref "/operate/rc/api/api-reference#tag/Subscriptions-Pro/operation/getSubscriptionById" >}}), where the `{subscriptionId}` is the resource ID that you receive when the task is in the `processing-completed` state. +For example, when you provision a new subscription, use [`GET /v1/subscriptions/{subscriptionId}`](/content/operate/rc/api/api-reference.md#tag/Subscriptions-Pro/operation/getSubscriptionById), where the `{subscriptionId}` is the resource ID that you receive when the task is in the `processing-completed` state. ### Provisioning state values diff --git a/content/operate/rc/api/get-started/use-rest-api.md b/content/operate/rc/api/get-started/use-rest-api.md index 305d14c9a0..30a0529340 100644 --- a/content/operate/rc/api/get-started/use-rest-api.md +++ b/content/operate/rc/api/get-started/use-rest-api.md @@ -14,9 +14,8 @@ You can access and use the API endpoint URI ([`https://api.redislabs.com/v1`](ht - The cURL HTTP client - An HTTP client in any programming language -{{< note >}} -For the Redis Cloud API, there is a request limit of 400 requests per minute per Account API key. If you go past this limit, your API requests will fail. -{{< /note >}} +> [!NOTE] +> For the Redis Cloud API, there is a request limit of 400 requests per minute per Account API key. If you go past this limit, your API requests will fail. ## Swagger user interface @@ -38,13 +37,12 @@ To authenticate to the Swagger UI: 1. Insert the API Key values: - 1. Enter the [Account Key]({{< relref "/operate/rc/api/get-started/enable-the-api.md" >}}) as the `x-api-key` value and then choose **Authorize**. - 1. Enter the [Secret Key]({{< relref "/operate/rc/api/get-started/manage-api-keys.md" >}}) as the `x-api-secret-key` value and then choose **Authorize**. + 1. Enter the [Account Key](/content/operate/rc/api/get-started/enable-the-api.md) as the `x-api-key` value and then choose **Authorize**. + 1. Enter the [Secret Key](/content/operate/rc/api/get-started/manage-api-keys.md) as the `x-api-secret-key` value and then choose **Authorize**. 1. Select **Close**. -{{< note >}} -The key values are not saved when you refresh the page. -{{< /note >}} +> [!NOTE] +> The key values are not saved when you refresh the page. When authorization is successful, the lock icon displays a closed lock. @@ -85,9 +83,8 @@ Some API operations require input, such as: {{< image filename="/images/rv/api/swagger-post-edit-body.png" >}} -{{< warning >}} -The Swagger UI generates default JSON examples for `POST` and `PUT` operations. You should modify these examples to suit your specific needs and account settings. The examples will fail if used as-is.

For more examples showing how to use specific endpoints, see [REST API examples]({{< relref "/operate/rc/api/examples" >}}). -{{< /warning >}} +> [!WARNING] +> The Swagger UI generates default JSON examples for `POST` and `PUT` operations. You should modify these examples to suit your specific needs and account settings. The examples will fail if used as-is.

For more examples showing how to use specific endpoints, see [REST API examples](/content/operate/rc/api/examples/_index.md). ## Use the `cURL` HTTP client @@ -95,10 +92,9 @@ The Swagger UI generates default JSON examples for `POST` and `PUT` operations. either as individual commands or within shell scripts (such as bash and zsh). For an introduction, see [How to start using cURL and why: a hands-on introduction](https://www.freecodecamp.org/news/how-to-start-using-curl-and-why-a-hands-on-introduction-ea1c913caaaa/). -{{% info %}} -Our examples use `cURL` and Linux shell scripts to demonstrate the API; you can use any standard REST client or library.

-Our examples also use `jq`, [a JSON parser](https://stedolan.github.io/jq/). Use your package manager to install it (Example: `sudo apt install jq`) -{{% /info %}} +> [!INFO] +> Our examples use `cURL` and Linux shell scripts to demonstrate the API; you can use any standard REST client or library.

+> Our examples also use `jq`, [a JSON parser](https://stedolan.github.io/jq/). Use your package manager to install it (Example: `sudo apt install jq`) For example, a standard API call to get System Log information looks like this in `cURL`: @@ -113,8 +109,8 @@ curl -s -X GET "https://$HOST/logs" \ - The example expects several variables to be set in the Linux shell: - **$HOST** - The URI of the REST API host (`api.redislabs.com/v1`) - - **$ACCOUNT_KEY** - The [account key value]({{< relref "/operate/rc/api/get-started/enable-the-api.md" >}}) - - **$SECRET_KEY** - The personal [secret key value]({{< relref "/operate/rc/api/get-started/manage-api-keys.md" >}}) + - **$ACCOUNT_KEY** - The [account key value](/content/operate/rc/api/get-started/enable-the-api.md) + - **$SECRET_KEY** - The personal [secret key value](/content/operate/rc/api/get-started/manage-api-keys.md) - The line "`| jq -r .`" means that the HTTP response will be piped (forwarded) to the `jq` JSON parser, and it will display only the raw output ("`-r`") of the root element ("`.`") - You can set the variables using shell commands like the following: diff --git a/content/operate/rc/cloud-integrations/_index.md b/content/operate/rc/cloud-integrations/_index.md index 62612a8e06..fe9a6f6b2b 100644 --- a/content/operate/rc/cloud-integrations/_index.md +++ b/content/operate/rc/cloud-integrations/_index.md @@ -16,9 +16,9 @@ By default, Redis Cloud subscriptions are hosted in cloud vendor accounts owned To integrate Redis Cloud into an existing cloud vendor account, you can: -- Subscribe to Redis Cloud through [AWS Marketplace]({{< relref "/operate/rc/cloud-integrations/aws-marketplace/" >}}). +- Subscribe to Redis Cloud through [AWS Marketplace](/content/operate/rc/cloud-integrations/aws-marketplace/_index.md). -- Subscribe to Redis Cloud through [Google Cloud Marketplace]({{< relref "/operate/rc/cloud-integrations/gcp-marketplace/" >}}). +- Subscribe to Redis Cloud through [Google Cloud Marketplace](/content/operate/rc/cloud-integrations/gcp-marketplace/_index.md). When you subscribe to Redis Cloud through a cloud vendor marketplace, billing is handled through the marketplace. @@ -32,6 +32,6 @@ When billing details change, you should verify that each service is operating no For best results, we recommend: -- [Backing up all data]({{< relref "/operate/rc/databases/back-up-data" >}}) _before_ updating billing details. +- [Backing up all data](/content/operate/rc/databases/back-up-data.md) _before_ updating billing details. - Contacting [support](https://redis.io/support/) or your account team for assistance. \ No newline at end of file diff --git a/content/operate/rc/cloud-integrations/aws-marketplace/_index.md b/content/operate/rc/cloud-integrations/aws-marketplace/_index.md index 3a76199b9e..5c6e406751 100644 --- a/content/operate/rc/cloud-integrations/aws-marketplace/_index.md +++ b/content/operate/rc/cloud-integrations/aws-marketplace/_index.md @@ -37,13 +37,12 @@ Here's how to subscribe to Redis Cloud with AWS Marketplace: 1. Use the **Connect account** button to confirm your choice. - {{< note >}} -You must complete this step to bill your Redis Cloud resources to your AWS Marketplace account. - {{< /note >}} + > [!NOTE] + > You must complete this step to bill your Redis Cloud resources to your AWS Marketplace account. 1. Once your Redis account is mapped to your AWS Marketplace account, your AWS Marketplace account will be charged for all your Redis Cloud resources going forward. -At this point, you can create a new database using the [standard workflow]({{< relref "/operate/rc/databases/create-database" >}}), with one important change. You don't need to enter a payment method, as it's automatically assigned to your AWS Marketplace account. +At this point, you can create a new database using the [standard workflow](/content/operate/rc/databases/create-database/_index.md), with one important change. You don't need to enter a payment method, as it's automatically assigned to your AWS Marketplace account. To confirm this, review the payment method associated with your subscription. diff --git a/content/operate/rc/cloud-integrations/gcp-marketplace/_index.md b/content/operate/rc/cloud-integrations/gcp-marketplace/_index.md index 821126f2f4..7edf57bd2b 100644 --- a/content/operate/rc/cloud-integrations/gcp-marketplace/_index.md +++ b/content/operate/rc/cloud-integrations/gcp-marketplace/_index.md @@ -52,9 +52,8 @@ Here's how to subscribe to Redis Cloud with Google Cloud marketplace: 1. Select **Connect account** to confirm your choice. - {{< note >}} -You must complete this step to bill your Redis Cloud resources to your Google Cloud Marketplace account. - {{< /note >}} + > [!NOTE] + > You must complete this step to bill your Redis Cloud resources to your Google Cloud Marketplace account. 1. After you connect your Redis account to your Google Cloud Marketplace account, your Google Cloud Marketplace account will be charged for all your Redis Cloud resources going forward. @@ -62,11 +61,11 @@ You must complete this step to bill your Redis Cloud resources to your Google Cl {{The Manage on Provider button}} -At this point, you can create a new database using the [standard workflow]({{< relref "/operate/rc/databases/create-database" >}}), with one important change. You don't need to enter a payment method, as it automatically uses your Google Cloud Marketplace account. +At this point, you can create a new database using the [standard workflow](/content/operate/rc/databases/create-database/_index.md), with one important change. You don't need to enter a payment method, as it automatically uses your Google Cloud Marketplace account. To confirm this, review the payment method associated with your subscription. -Additional users can be added on the Redis Cloud console using the [Access Management]({{< relref "/operate/rc/security/access-control/access-management" >}}) page. +Additional users can be added on the Redis Cloud console using the [Access Management](/content/operate/rc/security/access-control/access-management.md) page. If your Google Cloud Marketplace account is deactivated or otherwise unavailable, you can't use your subscription until you update the billing method. For help, [contact support](https://redis.io/support/). diff --git a/content/operate/rc/cloud-integrations/gcp-marketplace/team-management.md b/content/operate/rc/cloud-integrations/gcp-marketplace/team-management.md index 5818c3980e..caf478f1c2 100644 --- a/content/operate/rc/cloud-integrations/gcp-marketplace/team-management.md +++ b/content/operate/rc/cloud-integrations/gcp-marketplace/team-management.md @@ -12,7 +12,7 @@ weight: $weight --- {{}} -This article applies to an earlier Google Cloud marketplace listing. For the current [Redis Cloud - Pay as You Go](https://console.cloud.google.com/marketplace/product/redis-marketplace-isaas/redis-enterprise-cloud-flexible-plan) listing, manage your team through the [Access Management]({{< relref "/operate/rc/security/access-control/access-management" >}}) screen. See [Sign up for Redis Cloud with Google Cloud Marketplace]({{< relref "/operate/rc/cloud-integrations/gcp-marketplace/" >}}) for more information. +This article applies to an earlier Google Cloud marketplace listing. For the current [Redis Cloud - Pay as You Go](https://console.cloud.google.com/marketplace/product/redis-marketplace-isaas/redis-enterprise-cloud-flexible-plan) listing, manage your team through the [Access Management](/content/operate/rc/security/access-control/access-management.md) screen. See [Sign up for Redis Cloud with Google Cloud Marketplace](/content/operate/rc/cloud-integrations/gcp-marketplace/_index.md) for more information. {{}} If you subscribed to Redis Cloud through Google Cloud Marketplace using the **Redis Cloud** listing, use the IAM section of the Google Cloud console to manage your team. diff --git a/content/operate/rc/cloud-integrations/vercel.md b/content/operate/rc/cloud-integrations/vercel.md index cca2d8e755..f0e0696a81 100644 --- a/content/operate/rc/cloud-integrations/vercel.md +++ b/content/operate/rc/cloud-integrations/vercel.md @@ -20,7 +20,7 @@ The [Redis Cloud Vercel integration](https://vercel.com/marketplace/redis-cloud) 1. Navigate to the **Storage** tab. Under **Marketplace Database Providers**, find **Redis** and select **Create**. {{The Redis database provider in the Vercel Storage tab.}} -1. In the **Install integration** dialog under **Configuration and plan**, select your region and [high availability]({{< relref "/operate/rc/databases/configuration/high-availability" >}}) settings. +1. In the **Install integration** dialog under **Configuration and plan**, select your region and [high availability](/content/operate/rc/databases/configuration/high-availability.md) settings. {{Vercel Region and high availability settings}} @@ -36,7 +36,7 @@ After creation, you will see your database details. After provisioning is comple {{Vercel database details}} -You can use the connection string shown under **Quickstart** to [connect to your database]({{}}). +You can use the connection string shown under **Quickstart** to [connect to your database](/content/operate/rc/databases/connect/_index.md). ## Link database to your project @@ -63,10 +63,10 @@ From the database detail page, select **Open in Redis**. Your Redis Cloud account is linked to your Vercel account. All your team's Redis databases will be listed under **Databases** in Redis Cloud. -{{< warning >}} -Anybody on your team that has a [Vercel access role](https://vercel.com/docs/rbac/access-roles) other than **Pro Viewer**, **Enterprise Viewer**, or **Billing**, can make changes to your database configuration on the Redis Cloud console as if they were an **Owner** on Redis Cloud. See [Team management roles]({{< relref "/operate/rc/security/access-control/access-management#team-management-roles" >}}) for more information. -{{}} +> [!WARNING] +> Anybody on your team that has a [Vercel access role](https://vercel.com/docs/rbac/access-roles) other than **Pro Viewer**, **Enterprise Viewer**, or **Billing**, can make changes to your database configuration on the Redis Cloud console as if they were an **Owner** on Redis Cloud. See [Team management roles](/content/operate/rc/security/access-control/access-management.md#team-management-roles) for more information. Select your new database to make configuration changes such as passwords or the eviction policy. -{{}} The [eviction policy]({{}}) defaults to `no eviction` for new databases. You can change this by [editing the database details]({{}}).{{}} +> [!NOTE] +> The [eviction policy](/content/operate/rc/databases/configuration/data-eviction-policies.md) defaults to `no eviction` for new databases. You can change this by [editing the database details](/content/operate/rc/databases/view-edit-database.md). diff --git a/content/operate/rc/context-engine/_index.md b/content/operate/rc/context-engine/_index.md index cb23f4693c..5e5b91b085 100644 --- a/content/operate/rc/context-engine/_index.md +++ b/content/operate/rc/context-engine/_index.md @@ -13,11 +13,11 @@ weight: 36 ## Redis Cloud -* [Redis Agent Memory on Redis Cloud]({{< relref "/operate/iris/agent-memory" >}}) +* [Redis Agent Memory on Redis Cloud](/content/operate/iris/agent-memory/_index.md) Store agent memory for AI applications in Redis Cloud. -* [Semantic caching with LangCache on Redis Cloud]({{< relref "/operate/iris/langcache" >}}) +* [Semantic caching with LangCache on Redis Cloud](/content/operate/iris/langcache/_index.md) Store LLM responses for AI applications in Redis Cloud. -* [Redis Context Retriever on Redis Cloud]({{< relref "/operate/iris/context-retriever" >}}) +* [Redis Context Retriever on Redis Cloud](/content/operate/iris/context-retriever/_index.md) Expose schema first retrieval tools from your Redis Cloud data to AI agents. diff --git a/content/operate/rc/context-engine/agent-memory/_index.md b/content/operate/rc/context-engine/agent-memory/_index.md index 91bd4bd3bb..f15dea9719 100644 --- a/content/operate/rc/context-engine/agent-memory/_index.md +++ b/content/operate/rc/context-engine/agent-memory/_index.md @@ -16,6 +16,6 @@ aliases: Redis Agent Memory is available as a managed service on Redis Cloud. -Use the Redis Iris operational documentation to [create an Agent Memory service]({{< relref "/operate/iris/agent-memory/create-service" >}}), [configure its AI models]({{< relref "/operate/iris/agent-memory/model-configuration" >}}), or [view and manage an existing service]({{< relref "/operate/iris/agent-memory/view-service" >}}). +Use the Redis Iris operational documentation to [create an Agent Memory service](/content/operate/iris/agent-memory/create-service.md), [configure its AI models](/content/operate/iris/agent-memory/model-configuration.md), or [view and manage an existing service](/content/operate/iris/agent-memory/view-service.md). -For deployment options, see the [Agent Memory operational overview]({{< relref "/operate/iris/agent-memory" >}}). +For deployment options, see the [Agent Memory operational overview](/content/operate/iris/agent-memory/_index.md). diff --git a/content/operate/rc/context-engine/context-retriever/_index.md b/content/operate/rc/context-engine/context-retriever/_index.md index 98ba8865ba..871f43108e 100644 --- a/content/operate/rc/context-engine/context-retriever/_index.md +++ b/content/operate/rc/context-engine/context-retriever/_index.md @@ -13,4 +13,4 @@ weight: 30 Redis Context Retriever is available as a managed service on Redis Cloud. -Use the Redis Iris operational documentation to [create and manage a Context Retriever service]({{< relref "/operate/iris/context-retriever" >}}). +Use the Redis Iris operational documentation to [create and manage a Context Retriever service](/content/operate/iris/context-retriever/_index.md). diff --git a/content/operate/rc/context-engine/langcache/_index.md b/content/operate/rc/context-engine/langcache/_index.md index f9f6d90d8b..7f3cda7b19 100644 --- a/content/operate/rc/context-engine/langcache/_index.md +++ b/content/operate/rc/context-engine/langcache/_index.md @@ -13,4 +13,4 @@ weight: 20 LangCache is available as a managed service on Redis Cloud. -Use the Redis Iris operational documentation to [create and manage a LangCache service]({{< relref "/operate/iris/langcache" >}}). +Use the Redis Iris operational documentation to [create and manage a LangCache service](/content/operate/iris/langcache/_index.md).