Capability library / Application package

Redis package v1.0.0

Redis Cloud REST API: read subscriptions and databases, create and update subscriptions and databases, and delete databases or entire subscriptions.

Review state: Reviewed · Distributable: yes, digest matches the release manifest

This page describes AAES Govern’s controls. AAES Operate has private-work permissions, operational reviews and recorded-spend limits; it does not include Govern. About AAES Govern

Before you enable this package

The endpoint host 'redis-cloud.invalid' is a reserved .invalid placeholder that fails closed until you substitute the real host in both the endpoint URLs and the egress allowlist.

Read each action's effects and exclusions below. Before installation, also read the complete package requirements, including credential issuance, scope, expiry, and provider permissions. These are deployment prerequisites, not capabilities this package supplies.

Capabilities (7)

Each capability below is one registered operation. The complete package JSON includes its exact network destination allowlist. The repository stores it at packs/redis.json and embeds a copy in the release binary.

Risk tiers. R0 is the minimum for reads. R2 is the minimum for write, create, update, execute, and invoke. R3 is the minimum for delete, send, pay, deploy, approve, share, and transfer. Operators can raise these levels. A minimum tier does not measure the operation's business or confidentiality risk.

On supported execution paths routed through AAES Govern, the R3 actions listed below require approval by an authorized person. Bypass paths and observation-only registrations are outside that guarantee. A provider's restoration feature does not remove this approval requirement. A provider-side approval, such as approving a GitLab merge request, is also separate from AAES Govern human approval. The capability matrix shows which execution paths are implemented, restricted to lab use, or refused at startup. Live compatibility must be tested in your environment.

Field guide. Endpoint is the service address and request method. Connector is the adapter that makes the call. Custody describes how the credential is held; the credential reference identifies the value to resolve. Data class sets handling requirements: pii means personal data, financial means financial records, and internal means internal organizational data.

redis.cloud.subscriptions.read v1.0.0R0

Kind
tool
Action
read
Endpoint
GET https://redis-cloud.invalid/v1/subscriptions
Connector
http
Custody
customer_vault
Credential ref
secret-ref-redis-cloud-api-keys
Data class
internal

Read cloud subscriptions.

List the subscriptions on the account: names, cloud providers, regions and status. The registered path covers the collection read only — single-subscription reads (GET /v1/subscriptions/{id}) are not registered.

The host is a reserved placeholder: substitute the real Redis Cloud API host before enabling.

redis.cloud.databases.read v1.0.0R0

Kind
tool
Action
read
Endpoint
GET https://redis-cloud.invalid/v1/subscriptions/SUBSCRIPTION_ID/databases
Connector
http
Custody
customer_vault
Credential ref
secret-ref-redis-cloud-api-keys
Data class
internal

Read cloud databases.

List the databases in one subscription: names, memory limits, endpoints and status. Database endpoints reveal connection topology; database content is never exposed by this management API. The registered path covers the collection read only. SUBSCRIPTION_ID is a placeholder the deployment binds before enabling.

redis.cloud.subscription.create v1.0.0R3

Kind
tool
Actions
create, deploy
Endpoint
POST https://redis-cloud.invalid/v1/subscriptions
Connector
http
Custody
customer_vault
Credential ref
secret-ref-redis-cloud-api-keys
Data class
internal

Create cloud subscription.

Create a subscription and provision live, billable infrastructure. The unrestricted body selects the cloud provider, regions, payment method reference, and initial database plan. Review ongoing costs through deployment budget controls; this file does not cap provider charges.

Provisioning is asynchronous: the response identifies a task to poll. Registered as create and deploy at R3. Enforce any restriction to smaller plans separately; the registration does not enforce that intention.

redis.cloud.database.create v1.0.0R3

Kind
tool
Actions
create, deploy
Endpoint
POST https://redis-cloud.invalid/v1/subscriptions/SUBSCRIPTION_ID/databases
Connector
http
Custody
customer_vault
Credential ref
secret-ref-redis-cloud-api-keys
Data class
internal

Create cloud database.

Create one database in a subscription.

The request body is an unrestricted database definition — memory limit, throughput, modules, replication, persistence and the database password are settable — so the capability carries the full create effect; a password in the body is secret material the executor must keep out of logs exactly like the API keys themselves. Provisioning is asynchronous. Creating a database provisions live, billable infrastructure, so the capability declares create and deploy at the minimum R3 tier. SUBSCRIPTION_ID is a placeholder the deployment binds before enabling.

redis.cloud.database.update v1.0.0R3

Kind
tool
Actions
update, deploy
Endpoint
PUT https://redis-cloud.invalid/v1/subscriptions/SUBSCRIPTION_ID/databases/DATABASE_ID
Connector
http
Custody
customer_vault
Credential ref
secret-ref-redis-cloud-api-keys
Data class
internal

Update cloud database.

Update a database's memory limit, throughput, alerts, replication, security settings, or password. The update body is unrestricted within the provider schema. A new password is secret material and must stay out of logs.

Resizing changes live, billable capacity, so the capability declares update and deploy at R3. The reviewed OpenAPI specification does not establish whether password changes disconnect existing clients or whether shrinking a plan can evict data. Verify both against the live deployment before relying on either outcome.

Bind SUBSCRIPTION_ID and DATABASE_ID before enabling. Review every permitted effect of the requested configuration change.

redis.cloud.database.delete v1.0.0R3

Kind
tool
Action
delete
Endpoint
DELETE https://redis-cloud.invalid/v1/subscriptions/SUBSCRIPTION_ID/databases/DATABASE_ID
Connector
http
Custody
customer_vault
Credential ref
secret-ref-redis-cloud-api-keys
Data class
internal

Delete cloud database.

Delete one database. Deleting a database destroys its content — data not covered by a backup is gone, and re-creating a database later is a new database, not an undo of this call. Delete is one of the designated actions requiring human approval and registers at the minimum R3 tier.

On supported execution paths mediated by AAES Govern, irreversible actions require approval by an authorized person; this does not prevent calls through bypass or observation-only paths. Deletion is asynchronous (the response is a task to poll). SUBSCRIPTION_ID and DATABASE_ID are placeholders the deployment binds before enabling.

redis.cloud.subscription.delete v1.0.0R3

Kind
tool
Action
delete
Endpoint
DELETE https://redis-cloud.invalid/v1/subscriptions/SUBSCRIPTION_ID
Connector
http
Custody
customer_vault
Credential ref
secret-ref-redis-cloud-api-keys
Data class
internal

Delete cloud subscription.

Delete a subscription. Verified prerequisite from the vendor's OpenAPI operation description (deleteSubscriptionById, retrieved verbatim): a subscription cannot be deleted while any databases remain in it — the deployment must delete every database first (registered separately above) — and deleting the subscription stops its billing; this registration claims NO cascade deletion of databases by this call. Delete is one of the designated actions requiring human approval and registers at the minimum R3 tier.

On supported execution paths mediated by AAES Govern, irreversible actions require approval by an authorized person; this does not prevent calls through bypass or observation-only paths. Policy can raise the tier above the minimum. Deletion is asynchronous (the response is a task to poll). SUBSCRIPTION_ID is a placeholder the deployment binds before enabling.

Credential reference

The credential field names a reference rather than containing credential material. Packs are designed not to contain secrets; the format checks cover only known credential formats and cannot prove that arbitrary text contains no secrets. Installing a package registers its capabilities. Configure the provider credentials, endpoints, and network access, then test the integration in your environment before enabling it.

Reference
secret-ref-redis-cloud-api-keys
Custody
customer_vault
Injection
headers

Configure the value and injection format specified in the package. Assign responsibility for credential rotation and revocation, restrict provider permissions, and keep credential material out of logs and responses.

Complete credential requirements

Redis Cloud REST API credentials for the customer's own account, held in the client's own secret manager. Authentication requires TWO headers on every request: the account key as 'x-api-key' and a user (secret) key as 'x-api-secret-key'. The stored material is ONE exact value: a single JSON object of the form {"x-api-key":"<account key>","x-api-secret-key":"<user key>"}. Presentation: this registration declares the 'headers' injection mode with inject_headers [x-api-key, x-api-secret-key]; the connector parses the stored object and places each named header on the request, refusing material whose keys are not exactly the declared pair and refusing any caller-supplied spelling of either header, so the two-header contract is what the injector implements.

Issuance: the API is disabled by default; enabling it generates the account key once, and changing or deleting the account key requires contacting Redis support — there is no self-serve rotation of the account key. User keys are personal keys issued to users holding the Owner, Viewer, Billing admin or Logs viewer role, are shown only once at creation, and may be scoped to a CIDR allow list of source IPs.

Least privilege: create a dedicated user for this integration with the minimum role that covers the enabled capabilities (a Viewer-role key cannot perform the writes), issue it its own user key so system-log audit attributes requests to this integration, and set the CIDR allow list to the executor's egress addresses.

Expiry and revocation: the reviewed documentation describes no automatic expiry; a user key stays valid until it is deleted in the console (or the owning user is removed), and disabling the ability to create NEW keys does NOT invalidate already-issued keys — revocation means deleting each issued key, and account-key replacement goes through support. Renewal and rotation ownership sits with an external deployment process; the executor injects the stored values verbatim and performs no key lifecycle itself.

Executor hygiene: the values must live only in executor memory for the lifetime of a call, must never be written to logs, traces or diagnostics, and must not appear in crash dumps; a deployment that cannot meet that bar must not enable the pack.

Resources

  • redis-cloud-account (api, internal): https://redis-cloud.invalid/v1

Technical package and review record

Complete provider requirements and exclusions

The endpoint host 'redis-cloud.invalid' is a reserved non-production placeholder (an RFC 2606 reserved TLD): substitute the Redis Cloud REST API host the deployment actually uses (the documented API endpoint URI is https://api.redislabs.com/v1) before enabling, in every endpoint, in the resource locator and in every egress allowlist entry — the allowlist matches exactly, so all three must be substituted together, and substitution is a required deployment step. SUBSCRIPTION_ID and DATABASE_ID in the endpoint paths are placeholders the deployment binds to concrete resources before enabling.

Two-header contract: Redis Cloud authenticates EVERY API request with two headers — the account key in 'x-api-key' and a personal user key in 'x-api-secret-key' — and this pack declares the 'headers' injection mode, which parses the single stored JSON object and places both documented headers on every request; the credential note defines the exact stored value. The API is disabled on all accounts by default and must be enabled before any capability here works.

Provisioning is asynchronous: create, update and delete operations return a task the caller polls (GET /v1/tasks/{taskId}) — this pack registers the initiating operations only, and task polling is a read of the same class the deployment may register separately.

Documented exclusions — this pack does not register: user and role management (creating users or assigning roles under /v1/users and ACL endpoints), payment methods and billing operations, cloud account management (cloud accounts hold the customer's own cloud-provider credentials used for Bring-Your-Own-Cloud provisioning), database backup scheduling and especially database import (an import overwrites current database content — destructive to live data and deserving its own review), CRDB / Active-Active subscription management, SSO and SAML configuration, and system log export.

The vendor's API reference renders as a client-side Redoc UI, but the OpenAPI 3.0.1 specification backing it was retrieved verbatim for this review and every registered route, method, operationId and the per-operation two-header security requirement were checked against it; the asynchronous TaskStateUpdate responses match the pack's provisioning note.

Download the complete package JSON for exact network allowlists, credential requirements, exclusions, and setup notes. Read these requirements before installation.

The full documentation review record is supplied in the evaluation package. The evaluation package runs in your environment and comes only with the paid design partnership. This page reproduces the source links and review block; the full record is available for evaluation. Discuss a design partnership to inspect it before installation.

Review block

This section reproduces the review block recorded in the pack file. The evidence and approval record is separate: for a reviewed pack, it is in the evaluation materials and in the release binary's embedded assets.

Review completed: 2026-09-23

4 sources, retrieved 2026-09-21, 2026-09-23

Current documentation links are navigation aids. They do not change the package, its historical sources or its review date. Review dates describe a documentation review, not a live integration test. No package is provider-endorsed or yet tested against a live provider tenant.

Release identity

SHA-256 of the pack file bytes: 0bddb91fcbac710c927002cfc043fab4fce28f35df3ef610c9e7ace013001d86

Distributable: yes, digest matches the release manifest. Editing a package changes its release identity. A deployment plan checks its own file digests; it does not restore reviewed status or authenticate approval.