redocly logoAPI docs by Redocly

Redis Cloud API (Version 1)

Download OpenAPI specification:Download

Customer Support: support@redis.com URL: https://support.redislabs.com

Redis Cloud API

Account

Current account and ownership information

Get current Account

Current account and related information

Authorizations:
x-api-keyx-api-secret-key

Responses

Response samples

Content type
application/json
{
  • "account": {
    • "id": 1001,
    • "name": "Redis Labs",
    • "createdTimestamp": "2018-12-23T15:15:31Z",
    • "updatedTimestamp": "2022-10-12T10:54:10Z",
    • "pocStatus": "inactive",
    • "marketplaceStatus": "active",
    • "key": {
      • "name": "capi-api-key-name",
      • "accountId": 1001,
      • "accountName": "Redis Labs",
      • "allowedSourceIps": [
        • "0.0.0.0/0"
        ],
      • "createdTimestamp": "2022-05-11T12:05:47Z",
      • "owner": {
        • "name": "CAPI user",
        • "email": "capi.user@redis.com"
        },
      • "userAccountId": 1,
      • "httpSourceIp": "79.0.0.173"
      }
    }
}

Get list of data persistence options

Lookup list of data persistence values

Authorizations:
x-api-keyx-api-secret-key

Responses

Response samples

Content type
application/json
{
  • "dataPersistence": [
    • {
      • "name": "none",
      • "description": "None"
      },
    • {
      • "name": "aof-every-1-second",
      • "description": "Append only file (AOF) - fsync every 1 second"
      },
    • {
      • "name": "aof-every-write",
      • "description": "Append only file (AOF) - fsync every write"
      },
    • {
      • "name": "snapshot-every-1-hour",
      • "description": "Snapshot every 1 hour"
      },
    • {
      • "name": "snapshot-every-6-hours",
      • "description": "Snapshot every 6 hour"
      },
    • {
      • "name": "snapshot-every-12-hours",
      • "description": "Snapshot every 12 hour"
      }
    ],
  • "links": []
}

Get modules

Lookup list of database modules supported in current account (support may differ based on subscription and database settings)

Authorizations:
x-api-keyx-api-secret-key

Responses

Response samples

Content type
application/json
{
  • "modules": [
    • {
      • "name": "RedisBloom",
      • "capabilityName": "Probabilistic",
      • "description": "A set of probabilistic data structures to Redis, including Bloom filter, Cuckoo filter, Count-min sketch, Top-K, and t-digest",
      • "parameters": [ ]
      },
    • {
      • "name": "RedisJSON",
      • "capabilityName": "JSON",
      • "description": "Native JSON Data Type for Redis, allowing for atomic reads and writes of sub-elements",
      • "parameters": [ ]
      },
    • {
      • "name": "RediSearch",
      • "capabilityName": "Search and query",
      • "description": "A comprehensive, expressive, flexible, fast and developer-friendly search and query engine for the diversity of data types in Redis with state-of-the-art scoring algorithms",
      • "parameters": [
        • {
          • "name": "number-of-documents",
          • "description": "Expected number of documents the database module will be indexing",
          • "type": "integer",
          • "defaultValue": 1000000,
          • "required": false
          }
        ]
      },
    • {
      • "name": "RedisTimeSeries",
      • "capabilityName": "Time series",
      • "description": "Time-Series data structure for redis",
      • "parameters": [ ]
      }
    ]
}

Get payment methods

Lookup list of current Account's payment methods

Authorizations:
x-api-keyx-api-secret-key

Responses

Response samples

Content type
application/json
{
  • "accountId": 1001,
  • "paymentMethods": [
    • {
      • "id": 2,
      • "type": "Visa",
      • "creditCardEndsWith": "9349",
      • "nameOnCard": "CAPI User",
      • "expirationMonth": 2,
      • "expirationYear": 2026,
      • "links": [ ]
      }
    ]
}

Get Pro plans regions

Lookup list of regions for cloud provider

Authorizations:
x-api-keyx-api-secret-key
query Parameters
provider
string
Enum: "AWS" "GCP"

Provider Name

Responses

Response samples

Content type
application/json
{
  • "regions": [
    • {
      • "name": "us-east-1",
      • "provider": "AWS"
      },
    • {
      • "name": "us-west-1",
      • "provider": "AWS"
      },
    • {
      • "name": "us-west-2",
      • "provider": "AWS"
      },
    • {
      • "name": "eu-west-1",
      • "provider": "AWS"
      },
    • {
      • "name": "eu-central-1",
      • "provider": "AWS"
      },
    • {
      • "name": "ap-northeast-1",
      • "provider": "AWS"
      },
    • {
      • "name": "ap-southeast-1",
      • "provider": "AWS"
      },
    • {
      • "name": "ap-southeast-2",
      • "provider": "AWS"
      },
    • {
      • "name": "sa-east-1",
      • "provider": "AWS"
      },
    • {
      • "name": "us-east-2",
      • "provider": "AWS"
      },
    • {
      • "name": "eu-west-2",
      • "provider": "AWS"
      },
    • {
      • "name": "eu-west-3",
      • "provider": "AWS"
      },
    • {
      • "name": "eu-north-1",
      • "provider": "AWS"
      },
    • {
      • "name": "ca-central-1",
      • "provider": "AWS"
      },
    • {
      • "name": "ap-east-1",
      • "provider": "AWS"
      },
    • {
      • "name": "ap-south-1",
      • "provider": "AWS"
      },
    • {
      • "name": "asia-east1",
      • "provider": "GCP"
      },
    • {
      • "name": "asia-east2",
      • "provider": "GCP"
      },
    • {
      • "name": "asia-northeast1",
      • "provider": "GCP"
      },
    • {
      • "name": "asia-northeast2",
      • "provider": "GCP"
      },
    • {
      • "name": "asia-south1",
      • "provider": "GCP"
      },
    • {
      • "name": "asia-southeast1",
      • "provider": "GCP"
      },
    • {
      • "name": "australia-southeast1",
      • "provider": "GCP"
      },
    • {
      • "name": "europe-north1",
      • "provider": "GCP"
      },
    • {
      • "name": "europe-west1",
      • "provider": "GCP"
      },
    • {
      • "name": "europe-west2",
      • "provider": "GCP"
      },
    • {
      • "name": "europe-west3",
      • "provider": "GCP"
      },
    • {
      • "name": "europe-west4",
      • "provider": "GCP"
      },
    • {
      • "name": "europe-west6",
      • "provider": "GCP"
      },
    • {
      • "name": "northamerica-northeast1",
      • "provider": "GCP"
      },
    • {
      • "name": "southamerica-east1",
      • "provider": "GCP"
      },
    • {
      • "name": "us-central1",
      • "provider": "GCP"
      },
    • {
      • "name": "us-east1",
      • "provider": "GCP"
      },
    • {
      • "name": "us-east4",
      • "provider": "GCP"
      },
    • {
      • "name": "us-west1",
      • "provider": "GCP"
      },
    • {
      • "name": "us-west2",
      • "provider": "GCP"
      }
    ]
}

Get Query performance factors

Lookup list of supported Query performance factors

Authorizations:
x-api-keyx-api-secret-key

Responses

Response samples

Content type
application/json
{
  • "queryPerformanceFactors": [
    • "string"
    ],
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Get system log

System log information for current account

Authorizations:
x-api-keyx-api-secret-key
query Parameters
offset
integer <int32>

Number of items to skip

limit
integer <int32> [ 1 .. 1000 ]
Example: limit=100

Maximum number of items to return, but not more than 1000

Responses

Response samples

Content type
application/json
{
  • "entries": [
    • {
      • "id": 2900349,
      • "time": "2022-10-12T10:54:31Z",
      • "originator": "example-value",
      • "type": "Account",
      • "description": "example-value (example.value@redislabs.com)'s user name was changed to Example Value"
      },
    • {
      • "id": 2900348,
      • "time": "2022-10-12T10:54:11Z",
      • "originator": "invalid-name",
      • "type": "Account",
      • "description": "Invited invalid-name (cab@fufu.com) to join team"
      }
    ]
}

Subscriptions - Pro

All operations related to Pro subscriptions lifecycle

Accept a specific region transit gateway resource share

Accept an active active specific region AWS transit gateway resource share

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

regionId
required
integer <int32>
Example: 1

Region id (required for active-active subscription)

tgwInvitationId
required
integer <int32>

TgwInvitation Id

Responses

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Accept a transit gateway resource share

Accept an AWS transit gateway resource share

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

tgwInvitationId
required
integer <int32>

TgwInvitation Id

Responses

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Create a specific region transit gateway attachment

Create an active active specific region AWS transit gateway attachment

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

regionId
required
integer <int32>
Example: 1

Region id (required for active-active subscription)

TgwId
required
integer <int32>

Tgw Id

Responses

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Create a transit gateway attachment

Create an AWS transit gateway attachment

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

TgwId
required
integer <int32>

Tgw Id

Responses

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Create active-active subscription region

Create a new region in an active-active subscription

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

Request Body schema: application/json
required
region
string

Name of region to add as defined by cloud provider

deploymentCIDR
required
string

Deployment CIDR mask. Default: 192.168.0.0/24

dryRun
boolean

Optional. When 'false': Creates a deployment plan and deploys it (creating any resources required by the plan). When 'true': creates a read-only deployment plan without any resource creation. Default: 'false'

Array of objects (CrdbRegionSpec)

List of databases with local throughput for the new region

respVersion
string
Deprecated
Enum: "resp2" "resp3"

Optional. RESP version must be compatible with Redis version.

Responses

Request samples

Content type
application/json
{
  • "region": "string",
  • "deploymentCIDR": "10.0.0.0/24",
  • "dryRun": false,
  • "databases": [
    • {
      • "name": "string",
      • "localThroughputMeasurement": {
        • "region": "string",
        • "writeOperationsPerSecond": 1000,
        • "readOperationsPerSecond": 1000
        }
      }
    ],
  • "respVersion": "resp3"
}

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Create an active-active subscription VPC peering

Create a new VPC peering in an existing active-active subscription. For details, see documentation

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

Request Body schema: application/json
required
One of
provider
string
sourceRegion
string

Name of region to create a VPC peering from

destinationRegion
required
string

Name of region to create a VPC peering to

awsAccountId
required
string

AWS Account uid

vpcId
required
string

VPC Id

vpcCidr
string

Optional. VPC CIDR

vpcCidrs
Array of strings

Optional. List of VPC CIDRs

Responses

Request samples

Content type
application/json
{
  • "provider": "string",
  • "region": "us-east-1",
  • "awsAccountId": "<aws-account-id>",
  • "vpcId": "<vpc-identifier>",
  • "vpcCidrs": [
    • "<10.10.10.0/24>",
    • "<10.10.20.0/24>"
    ]
}

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Create subscription

Create a new subscription

Authorizations:
x-api-keyx-api-secret-key
Request Body schema: application/json
required
name
string

Optional. Subscription name

dryRun
boolean

Optional. When 'false': Creates a deployment plan and deploys it (creating any resources required by the plan). When 'true': creates a read-only deployment plan without any resource creation. Default: 'false'

deploymentType
string
Enum: "single-region" "active-active"

Optional. When 'single-region' or null: Creates a single region subscription. When 'active-active': creates an active-active (multi-region) subscription

paymentMethod
string
Enum: "credit-card" "marketplace"

Optional. The payment method for the requested subscription. If ‘credit-card’ is specified, ‘paymentMethodId’ must be defined. Default: 'credit-card

paymentMethodId
integer <int32>

Optional. A valid payment method that was pre-defined in the current account. This value is Optional if ‘paymentMethod’ is ‘marketplace’, but Required for all other account types.

memoryStorage
string
Enum: "ram" "ram-and-flash"

Optional. Memory storage preference: either 'ram' or a combination of 'ram-and-flash'. Default: 'ram'

required
Array of objects (SubscriptionSpec)

Required. Cloud hosting & networking details

required
Array of objects (SubscriptionDatabaseSpec)

Required. Databases specifications for each planned database

redisVersion
string

Optional. If specified, the redisVersion defines the Redis version of the databases in the subscription. If omitted, the Redis version will be the default (available in 'GET /subscriptions/redis-versions')

Responses

Request samples

Content type
application/json
{
  • "name": "My new subscription",
  • "dryRun": false,
  • "deploymentType": "single-region",
  • "paymentMethod": "credit-card",
  • "paymentMethodId": 12345,
  • "memoryStorage": "ram",
  • "persistentStorageEncryption": true,
  • "cloudProviders": [
    • {
      • "provider": "AWS",
      • "regions": [
        • {
          • "region": "us-east-1",
          • "multipleAvailabilityZones": true,
          • "preferredAvailabilityZones": [
            • "use1-az1",
            • "use1-az4",
            • "use1-az5"
            ],
          • "networking": {
            • "deploymentCIDR": "10.0.0.0/24"
            }
          }
        ]
      }
    ],
  • "databases": [
    • {
      • "name": "Redis-database-example",
      • "protocol": "redis",
      • "datasetSizeInGb": 2,
      • "supportOSSClusterApi": false,
      • "dataPersistence": "none",
      • "replication": true,
      • "throughputMeasurement": {
        • "by": "operations-per-second",
        • "value": 10000
        },
      • "quantity": 1
      }
    ]
}

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Create subscription peering

Create a new VPC peering in an existing subscription. VPC peering for Google Cloud Provider must be enabled using the GCloud command line. For details, see documentation

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

Request Body schema: application/json
required
One of
provider
string
region
required
string

Deployment region as defined by cloud provider

awsAccountId
required
string

AWS Account uid

vpcId
required
string

VPC uid

vpcCidr
string

Optional. VPC CIDR

vpcCidrs
Array of strings

Optional. List of VPC CIDRs

Responses

Request samples

Content type
application/json
{
  • "provider": "string",
  • "sourceRegion": "string",
  • "destinationRegion": "us-east-1",
  • "awsAccountId": "<aws-account-id>",
  • "vpcId": "<vpc-identifier>",
  • "vpcCidrs": [
    • "<10.10.10.0/24>",
    • "<10.10.20.0/24>"
    ]
}

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Delete a specific region transit gateway attachment

Delete an active active specific region AWS transit gateway attachment

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

regionId
required
integer <int32>
Example: 1

Region id (required for active-active subscription)

TgwId
required
integer <int32>

Tgw Id

Responses

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Delete a transit gateway attachment

Delete an AWS transit gateway attachment

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

TgwId
required
integer <int32>

Tgw Id

Responses

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Delete active-active subscription regions

Delete one or more regions from an active-active subscription

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

Request Body schema: application/json
required
Array of objects (ActiveActiveRegionToDelete)

List of names of regions to delete

dryRun
boolean

Optional. When 'false': Creates a deployment plan and deploys it (creating any resources required by the plan). When 'true': creates a read-only deployment plan without any resource creation. Default: 'false'

Responses

Request samples

Content type
application/json
{
  • "regions": [
    • {
      • "region": "string"
      }
    ],
  • "dryRun": false
}

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Delete an active-active subscription VPC peering

Delete a VPC peering from an existing active-active subscription.

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

peeringId
required
integer <int32>

VpcPeering Id

Responses

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Delete subscription

Delete a subscription identified by subscription Id (subscription must be empty, i.e. cannot contain databases)

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

Responses

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Delete subscription peering

Deletes a VPC peering identified by an id

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

peeringId
required
integer <int32>

VpcPeering Id

Responses

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Get Active Active Subscription tgw invitations

Get Active Active tgw invitations details

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

regionId
required
integer <int32>
Example: 1

Region id (required for active-active subscription)

Responses

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Get Active Active Subscription tgws

Get Active Active tgws details

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

regionId
required
integer <int32>
Example: 1

Region id (required for active-active subscription)

Responses

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Get active-active subscription regions

Get all regions of an active-active subscription

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

Responses

Response samples

Content type
application/json
{
  • "subscriptionId": 126,
  • "regions": [
    • {
      • "regionId": 1,
      • "region": "us-east-1",
      • "deploymentCidr": "10.0.0.0/24",
      • "vpcId": "vpc-0bf863584c46321e4",
      • "databases": [
        • {
          • "databaseId": 862,
          • "databaseName": "Bdb",
          • "readOperationsPerSecond": 500,
          • "writeOperationsPerSecond": 500,
          • "respVersion": "resp3",
          • "links": [ ]
          },
        • {
          • "databaseId": 864,
          • "databaseName": "Bdb2",
          • "readOperationsPerSecond": 1000,
          • "writeOperationsPerSecond": 1000,
          • "respVersion": "resp3",
          • "links": [ ]
          }
        ],
      • "links": [ ]
      },
    • {
      • "regionId": 4,
      • "region": "eu-west-1",
      • "deploymentCidr": "10.0.1.0/24",
      • "vpcId": "vpc-0108fb753063ecf8b",
      • "databases": [
        • {
          • "databaseId": 862,
          • "databaseName": "Bdb",
          • "readOperationsPerSecond": 500,
          • "writeOperationsPerSecond": 500,
          • "respVersion": "resp3",
          • "links": [ ]
          },
        • {
          • "databaseId": 864,
          • "databaseName": "Bdb2",
          • "readOperationsPerSecond": 1000,
          • "writeOperationsPerSecond": 1000,
          • "respVersion": "resp3",
          • "links": [ ]
          }
        ],
      • "links": [ ]
      }
    ],
  • "links": []
}

Get an active-active subscription VPC peering

Get VPC peering details for an active-active subscription.

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

Responses

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Get subscription by id

Information on subscription identified by subscription Id

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

Responses

Response samples

Content type
application/json
{
  • "id": 1206,
  • "name": "updated new name",
  • "status": "active",
  • "deploymentType": "single-region",
  • "paymentMethodId": 2,
  • "memoryStorage": "ram",
  • "numberOfDatabases": 6,
  • "paymentMethodType": "credit-card",
  • "storageEncryption": false,
  • "subscriptionPricing": [
    • {
      • "type": "Shards",
      • "typeDetails": "high-throughput",
      • "quantity": 7,
      • "quantityMeasurement": "shards",
      • "pricePerUnit": 0.124,
      • "priceCurrency": "USD",
      • "pricePeriod": "hour"
      }
    ],
  • "cloudDetails": [
    • {
      • "provider": "AWS",
      • "cloudAccountId": 2,
      • "totalSizeInGb": 0.0272,
      • "regions": [
        • {
          • "region": "us-east-1",
          • "networking": [
            • {
              • "deploymentCIDR": "10.0.0.0/24",
              • "subnetId": "subnet-009ce004ed90da8a6"
              }
            ],
          • "preferredAvailabilityZones": [
            • "us-east-1a"
            ],
          • "multipleAvailabilityZones": false
          }
        ],
      • "links": [ ]
      }
    ],
  • "links": []
}

Get subscription CIDR

Get CIDR whitelist

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

Responses

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Get subscription maintenance windows

Get maintenance windows for subscription

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

Responses

Response samples

Content type
application/json
{
  • "mode": "manual",
  • "timeZone": "string",
  • "windows": [
    • {
      • "days": [
        • "string"
        ],
      • "startHour": 0,
      • "durationInHours": 0
      }
    ],
  • "skipStatus": {
    • "remainingSkips": 0,
    • "currentSkipEnd": "string"
    }
}

Get Subscription peering

Get VPC peering details

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

Responses

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Get subscription pricing

Get subscription pricing by by subscription Id

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

Responses

Response samples

Content type
application/json
{
  • "pricing": [
    • {
      • "type": "string",
      • "typeDetails": "string",
      • "quantity": 0,
      • "quantityMeasurement": "string",
      • "pricePerUnit": 0.1,
      • "priceCurrency": "string",
      • "pricePeriod": "string",
      • "region": "string"
      }
    ]
}

Get Subscription tgw invitations

Get tgw invitations details

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

Responses

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Get Subscription tgws

Get tgws details

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

Responses

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Get subscriptions

Information on current account's subscriptions

Authorizations:
x-api-keyx-api-secret-key

Responses

Response samples

Content type
application/json
{
  • "accountId": 1001,
  • "subscriptions": [
    • {
      • "id": 1206,
      • "name": "subscription name",
      • "status": "active",
      • "deploymentType": "single-region",
      • "paymentMethodId": 123,
      • "memoryStorage": "ram",
      • "numberOfDatabases": 6,
      • "paymentMethodType": "credit-card",
      • "storageEncryption": false,
      • "subscriptionPricing": [
        • {
          • "type": "Shards",
          • "typeDetails": "high-throughput",
          • "quantity": 7,
          • "quantityMeasurement": "shards",
          • "pricePerUnit": 0.124,
          • "priceCurrency": "USD",
          • "pricePeriod": "hour"
          }
        ],
      • "cloudDetails": [
        • {
          • "provider": "AWS",
          • "cloudAccountId": 1666,
          • "totalSizeInGb": 0.0272,
          • "regions": [
            • {
              • "region": "us-east-1",
              • "networking": [
                • {
                  • "deploymentCIDR": "10.0.0.0/24",
                  • "subnetId": "subnet-009ce004ed90da8a6"
                  }
                ],
              • "preferredAvailabilityZones": [
                • "us-east-1a"
                ],
              • "multipleAvailabilityZones": false
              }
            ],
          • "links": [ ]
          }
        ],
      • "links": [ ]
      }
    ]
}

Get the available Redis database versions

Get the available Redis database versions

Authorizations:
x-api-keyx-api-secret-key

Responses

Response samples

Content type
application/json
{
  • "redisVersions": [
    • {
      • "version": "string",
      • "eolDate": "2019-08-24",
      • "isPreview": true,
      • "isDefault": true
      }
    ]
}

Reject a specific region transit gateway resource share

Reject an active active specific region AWS transit gateway resource share

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

regionId
required
integer <int32>
Example: 1

Region id (required for active-active subscription)

tgwInvitationId
required
integer <int32>

TgwInvitation Id

Responses

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Reject a transit gateway resource share

Reject an AWS transit gateway resource share

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

tgwInvitationId
required
integer <int32>

TgwInvitation Id

Responses

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Update a specific region transit gateway attachment

Update an active active specific region AWS transit gateway attachment

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

regionId
required
integer <int32>
Example: 1

Region id (required for active-active subscription)

TgwId
required
integer <int32>

Tgw Id

Request Body schema: application/json
required
Array of objects (Cidr)

Optional. List of attachment CIDRs

Responses

Request samples

Content type
application/json
{
  • "cidrs": [
    • "10.10.10.0/24",
    • "10.10.20.0/24"
    ]
}

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Update a transit gateway attachment

Update an AWS transit gateway attachment

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

TgwId
required
integer <int32>

Tgw Id

Request Body schema: application/json
required
Array of objects (Cidr)

Optional. List of attachment CIDRs

Responses

Request samples

Content type
application/json
{
  • "cidrs": [
    • "10.10.10.0/24",
    • "10.10.20.0/24"
    ]
}

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Update an active-active subscription VPC peering

Update an existing VPC peering in an existing active-active subscription.

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

peeringId
required
integer <int32>

VpcPeering Id

Request Body schema: application/json
required
vpcCidr
string

Optional. VPC CIDR

vpcCidrs
Array of strings

Optional. List of VPC CIDRs

Responses

Request samples

Content type
application/json
{
  • "vpcCidrs": [
    • "<10.10.10.0/24>",
    • "<10.10.20.0/24>"
    ]
}

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Update subscription

Update an existing subscription by Id

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

Request Body schema: application/json
required
name
string

Subscription name

paymentMethodId
integer <int32>

Optional. A valid payment method that was pre-defined in the current account. This value is Optional if ‘paymentMethod’ is ‘marketplace’, but Required for all other account types.

paymentMethod
string
Enum: "credit-card" "marketplace"

Optional. The payment method for the requested subscription. If ‘credit-card’ is specified, ‘paymentMethodId’ must be defined. Default: 'credit-card

Responses

Request samples

Content type
application/json
{
  • "name": "My new subscription name",
  • "paymentMethodId": 0,
  • "paymentMethod": "credit-card"
}

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Update subscription CIDR

Update subscription CIDR whitelist

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

Request Body schema: application/json
required
cidrIps
Array of strings

CIDR values in an array format (example: ['10.1.1.0/32'])

securityGroupIds
Array of strings

AWS Security group identifier

Responses

Request samples

Content type
application/json
{
  • "cidrIps": [
    • "string"
    ],
  • "securityGroupIds": [
    • "string"
    ]
}

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Update subscription maintenance windows

Update maintenance windows for subscription

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

Request Body schema: application/json
required
mode
required
string
Enum: "manual" "automatic"

Required. Maintenance window mode: either 'manual' or 'automatic'. Must provide windows property if manual. Default: 'automatic'

Array of objects (MaintenanceWindowSpec)

Maintenance window specifications if mode is set to 'manual'. Up to 7 windows can be provided.

Responses

Request samples

Content type
application/json
{
  • "mode": "manual",
  • "windows": [
    • {
      • "startHour": 12,
      • "durationInHours": 8,
      • "days": [
        • "Monday",
        • "Wednesday"
        ]
      }
    ]
}

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Update subscription peering

Update an existing VPC peering in an existing subscription.

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

peeringId
required
integer <int32>

VpcPeering Id

Request Body schema: application/json
required
vpcCidr
string

Optional. VPC CIDR

vpcCidrs
Array of strings

Optional. List of VPC CIDRs

Responses

Request samples

Content type
application/json
{
  • "vpcCidrs": [
    • "<10.10.10.0/24>",
    • "<10.10.20.0/24>"
    ]
}

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Databases - Pro

All operations related to Pro databases lifecycle

Add database tags

Add single database tag for a given resource

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

databaseId
required
integer <int32>

Database Id

Request Body schema: application/json
required
key
required
string

Required. Database tag key

value
required
string

Required. Database tag value

Responses

Request samples

Content type
application/json
{
  • "key": "environment",
  • "value": "production"
}

Response samples

Content type
application/json
{}

Backup database

Manually backup a database into the destination defined for it

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

databaseId
required
integer <int32>

Database Id

Request Body schema: application/json
regionName
string

Optional. Name of cloud provider region where the local database is located. When backing up an active-active database, backup is done separately for each local database at a specified region.

adhocBackupPath
string

Optional. Path for ad-hoc backup.

Responses

Request samples

Content type
application/json
{
  • "regionName": "string",
  • "adhocBackupPath": "s3://<backup-path>"
}

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Backup database status

Information on the latest database backup status identified by subscription Id and database Id

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

databaseId
required
integer <int32>

Database Id

query Parameters
regionName
string

Region name (required for active-active subscription)

Responses

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Create database

Create a new database

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

Request Body schema: application/json
required
dryRun
boolean

Optional. When 'false': Creates a deployment plan and deploys it (creating any resources required by the plan). When 'true': creates a read-only deployment plan without any resource creation. Default: 'true'

name
required
string

Required. Database name (Database name must be up to 40 characters long, include only letters, digits, or hyphen ('-'), start with a letter, and end with a letter or digit)

protocol
string
Enum: "redis" "memcached"

Optional. Database protocol. Default: 'redis'

port
integer <int32>

Optional. TCP port on which the database is available (10000-19999). Generated automatically if omitted

memoryLimitInGb
number <double> >= 0.1

Deprecated - Optional. Total memory including replication and other overhead

datasetSizeInGb
number <double> >= 0.1

Optional. The maximum amount of data in the dataset for this specific database is in GB. You can not set both datasetSizeInGb and totalMemoryInGb. if 'replication' is true, the database’s total memory will be twice as large as the datasetSizeInGb.if 'replication' is false, the database’s total memory of the database will be the datasetSizeInGb value.

respVersion
string
Enum: "resp2" "resp3"

Optional. RESP version must be compatible with Redis version.

supportOSSClusterApi
boolean

Optional. Support Redis open-source (OSS) Cluster API. Default: 'false'

useExternalEndpointForOSSClusterApi
boolean

Optional. Should use external endpoint for open-source (OSS) Cluster API. Can only be enabled if OSS Cluster API support is enabled'. Default: 'false'

dataPersistence
string
Enum: "none" "aof-every-1-second" "aof-every-write" "snapshot-every-1-hour" "snapshot-every-6-hours" "snapshot-every-12-hours"

Optional. Rate of database data persistence (in persistent storage). Default: 'none'

dataEvictionPolicy
string
Enum: "allkeys-lru" "allkeys-lfu" "allkeys-random" "volatile-lru" "volatile-lfu" "volatile-random" "volatile-ttl" "noeviction"

Optional. Data items eviction method. Default: 'volatile-lru'

replication
boolean

Optional. Databases replication. Default: 'true'

replicaOf
Array of strings
Deprecated

Deprecated - Optional. This database will be a replica of the specified Redis databases provided as one or more URI (sample format: 'redis://user:password@host:port)'. If the URI provided is Redis Cloud instance, only host and port should be provided (using the format: ['redis://endpoint1:6379', 'redis://endpoint2:6380']).

object (ReplicaOfSpec)

Optional. Replica Of configuration

object (DatabaseThroughputSpec)

Optional. Throughput measurement method. Default: 25000 ops/sec

Array of objects (LocalThroughput)

Optional. Throughput measurement for an active-active subscription

averageItemSizeInBytes
integer <int64>

Optional. Relevant only to ram-and-flash subscriptions. Estimated average size (measured in bytes) of the items stored in the database, Default: 1000

periodicBackupPath
string

Deprecated - If specified, automatic backups will be every 24 hours or database will be able to perform immediate backups to this path. If empty string is received, backup path will be removed. Optional.

object (DatabaseBackupConfig)

Optional. Database remote backup configuration

sourceIp
Array of strings

Optional. List of source IP addresses or subnet masks. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges. example value: '['192.168.10.0/32', '192.168.12.0/24']'

clientSslCertificate
string

Deprecated - Optional. A string containing TLS/SSL certificate (public key) with new line characters replaced by \n. If specified, mTLS authentication (with enableTls not specified or set to true) will be required to authenticate user connections. If empty string is received, SSL certificate will be removed and mTLS will not be required (note that TLS connection may still apply, depending on the value of the enableTls property). Default: 'null'"

Array of objects (DatabaseCertificateSpec)

Optional. A list of TLS/SSL certificates (public keys) with new line characters replaced by \n. If specified, mTLS authentication (with enableTls not specified or set to true) will be required to authenticate user connections. If empty list is received, SSL certificates will be removed and mTLS will not be required (note that TLS connection may still apply, depending on the value of the enableTls property). Default: 'null'"

enableTls
boolean

Optional. When 'true', requires TLS authentication for all connections (mTLS with valid clientSslCertificate, regular TLS when the clientSslCertificate is not provided. Default: 'false'

password
string

Optional. Password to access the database. If omitted, a random 32 character long alphanumeric password will be automatically generated. Can only be set if Database Protocol is REDIS

saslUsername
string

Optional. Memcached (SASL) Username to access the database. If omitted, the username will be set to a 'mc-' prefix followed by a random 5 character long alphanumeric. Can only be set if Database Protocol is MEMCACHED

saslPassword
string

Optional. Memcached (SASL) Password to access the database. If omitted, a random 32 character long alphanumeric password will be automatically generated. Can only be set if Database Protocol is MEMCACHED

Array of objects (DatabaseAlertSpec)

Optional. Redis database alerts

Array of objects (DatabaseModuleSpec)

Optional. Redis modules to be provisioned in the database

queryPerformanceFactor
string

Optional. The query performance factor adds extra compute power specifically for search and query. For databases with search and query, you can increase your search queries per second by the selected factor.

Responses

Request samples

Content type
application/json
{
  • "dryRun": false,
  • "name": "Redis-database-example",
  • "port": 10000,
  • "datasetSizeInGb": 1,
  • "dataEvictionPolicy": "allkeys-lru",
  • "replication": true,
  • "throughputMeasurement": {
    • "by": "operations-per-second",
    • "value": 10000
    },
  • "alerts": [
    • {
      • "name": "dataset-size",
      • "value": 80
      }
    ]
}

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Delete database

Delete a specific database identified by subscription Id and database Id

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

databaseId
required
integer <int32>

Database Id

Responses

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Delete database tag by key

Delete database tag for a given resource by tag key

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

databaseId
required
integer <int32>

Database Id

tagKey
required
string
Example: environment

Tag key

Responses

Response samples

Content type
application/json
{ }

Flush database data

Flush database data

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

databaseId
required
integer <int32>

Database Id

Request Body schema: application/json
required

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Get database by id

Information on a specific database identified by subscription Id and database Id

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32> >= 0

Subscription Id

databaseId
required
integer <int32> >= 0

Database Id

Responses

Response samples

Content type
application/json
{
  • "databaseId": 1,
  • "name": "DB-RCP-2-81-7",
  • "protocol": "redis",
  • "provider": "AWS",
  • "region": "us-east-1",
  • "redisVersion": "7.4",
  • "respVersion": "resp3",
  • "status": "active",
  • "datasetSizeInGb": 2,
  • "memoryUsedInMb": 4,
  • "memoryStorage": "ram",
  • "supportOSSClusterApi": true,
  • "useExternalEndpointForOSSClusterApi": true,
  • "dataPersistence": "snapshot-every-1-hour",
  • "replication": false,
  • "dataEvictionPolicy": "noeviction",
  • "throughputMeasurement": {
    • "by": "operations-per-second",
    • "value": 2500
    },
  • "activatedOn": "2021-08-29T13:03:08Z",
  • "lastModified": "2021-08-29T13:03:08Z",
  • "publicEndpoint": "redis-17571.c235866.us-east-1-1.ec2.qa-cloud.rlrcp.com:17571",
  • "privateEndpoint": "redis-17571.internal.c235866.us-east-1-1.ec2.qa-cloud.rlrcp.com:17571",
  • "replica": {
    • "syncSources": [
      • {
        • "endpoint": "redis://localhost:6379",
        • "encryption": true,
        • "clientCert": "-----BEGIN CERTIFICATE-----\n ... -----END CERTIFICATE-----"
        }
      ]
    },
  • "clustering": {
    • "numberOfShards": 1,
    • "regexRules": [
      • {
        • "ordinal": 1,
        • "pattern": "(?<tag>.*)"
        },
      • {
        • "ordinal": 0,
        • "pattern": ".*\\{(?<tag>.*)\\}.*"
        }
      ],
    • "hashingPolicy": "standard"
    },
  • "security": {
    • "enableDefaultUser": true,
    • "password": "redis123456redis",
    • "sslClientAuthentication": false,
    • "tlsClientAuthentication": false,
    • "enableTls": false,
    • "sourceIps": [
      • "0.0.0.0/0"
      ]
    },
  • "modules": [
    • {
      • "id": 18536,
      • "name": "RedisJSON",
      • "capabilityName": "JSON",
      • "version": "2.0.6",
      • "description": "Native JSON Data Type for Redis, allowing for atomic reads and writes of sub-elements",
      • "parameters": [ ]
      }
    ],
  • "alerts": [ ],
  • "links": []
}

Get database certificate

X.509 PEM (base64) encoded certificate for TLS connection to the database

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32> >= 0

Subscription Id

databaseId
required
integer <int32> >= 0

Database Id

Responses

Response samples

Content type
application/json
{
  • "publicCertificatePEMString": "string"
}

Get database tags

Get database tags for a given resource

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

databaseId
required
integer <int32>

Database Id

Responses

Response samples

Content type
application/json
{
  • "accountId": 40131,
  • "tags": [
    • {
      • "key": "environment",
      • "value": "production",
      • "createdAt": "2024-05-21T20:02:21+02:00",
      • "updatedAt": "2024-06-21T20:02:21+02:00",
      • "links": [ ]
      },
    • {
      • "key": "owner",
      • "value": "Clifford O'neill",
      • "createdAt": "2024-05-21T20:02:21+02:00",
      • "updatedAt": "2024-06-21T20:02:21+02:00",
      • "links": [ ]
      }
    ],
  • "links": []
}

Get databases

Information on databases belonging to subscription identified by subscription Id

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32> >= 0

Subscription Id

query Parameters
offset
integer <int32>

Number of items to skip

limit
integer <int32>
Example: limit=100

Maximum number of items to return

Responses

Response samples

Content type
application/json
{
  • "accountId": 1001,
  • "subscription": [
    • {
      • "subscriptionId": 1206,
      • "numberOfDatabases": 6,
      • "databases": [
        • {
          • "databaseId": 1,
          • "name": "DB-RCP-2-81-7",
          • "protocol": "redis",
          • "provider": "AWS",
          • "region": "us-east-1",
          • "redisVersion": "7.4",
          • "respVersion": "resp2",
          • "status": "active",
          • "datasetSizeInGb": 2,
          • "memoryUsedInMb": 4,
          • "memoryStorage": "ram",
          • "supportOSSClusterApi": true,
          • "useExternalEndpointForOSSClusterApi": true,
          • "dataPersistence": "snapshot-every-1-hour",
          • "replication": false,
          • "dataEvictionPolicy": "noeviction",
          • "throughputMeasurement": {
            • "by": "operations-per-second",
            • "value": 2500
            },
          • "activatedOn": "2021-08-29T13:03:08Z",
          • "lastModified": "2021-08-29T13:03:08Z",
          • "publicEndpoint": "redis-17571.c235866.us-east-1-1.ec2.qa-cloud.rlrcp.com:17571",
          • "privateEndpoint": "redis-17571.internal.c235866.us-east-1-1.ec2.qa-cloud.rlrcp.com:17571",
          • "replica": {
            • "syncSources": [
              • {
                • "endpoint": "redis://localhost:6379",
                • "encryption": true,
                • "clientCert": "-----BEGIN CERTIFICATE-----\n ... -----END CERTIFICATE-----"
                }
              ]
            },
          • "clustering": {
            • "numberOfShards": 1,
            • "regexRules": [
              • {
                • "ordinal": 1,
                • "pattern": "(?<tag>.*)"
                },
              • {
                • "ordinal": 0,
                • "pattern": ".*\\{(?<tag>.*)\\}.*"
                }
              ],
            • "hashingPolicy": "standard"
            },
          • "security": {
            • "enableDefaultUser": true,
            • "sslClientAuthentication": false,
            • "tlsClientAuthentication": false,
            • "enableTls": false,
            • "sourceIps": [
              • "0.0.0.0/0"
              ]
            },
          • "modules": [
            • {
              • "id": 18536,
              • "name": "RedisJSON",
              • "capabilityName": "JSON",
              • "version": "2.0.6",
              • "description": "Native JSON Data Type for Redis, allowing for atomic reads and writes of sub-elements",
              • "parameters": [ ]
              }
            ],
          • "alerts": [ ],
          • "links": [ ]
          },
        • {
          • "databaseId": 2,
          • "name": "DB-RCP-2-81-5",
          • "protocol": "redis",
          • "provider": "AWS",
          • "region": "us-east-1",
          • "redisVersion": "7.4",
          • "status": "active",
          • "datasetSizeInGb": 2,
          • "memoryUsedInMb": 2,
          • "memoryStorage": "ram",
          • "supportOSSClusterApi": true,
          • "useExternalEndpointForOSSClusterApi": true,
          • "dataPersistence": "snapshot-every-1-hour",
          • "replication": false,
          • "dataEvictionPolicy": "noeviction",
          • "throughputMeasurement": {
            • "by": "operations-per-second",
            • "value": 25000
            },
          • "activatedOn": "2021-08-29T13:03:27Z",
          • "lastModified": "2021-08-29T13:03:27Z",
          • "publicEndpoint": "redis-11836.c235866.us-east-1-1.ec2.qa-cloud.rlrcp.com:11836",
          • "privateEndpoint": "redis-11836.internal.c235866.us-east-1-1.ec2.qa-cloud.rlrcp.com:11836",
          • "replica": {
            • "syncSources": [
              • {
                • "endpoint": "redis://localhost:6379",
                • "encryption": true,
                • "clientCert": "-----BEGIN CERTIFICATE-----\n ... -----END CERTIFICATE-----"
                }
              ]
            },
          • "clustering": {
            • "numberOfShards": 1,
            • "regexRules": [
              • {
                • "ordinal": 0,
                • "pattern": ".*\\{(?<tag>.*)\\}.*"
                },
              • {
                • "ordinal": 1,
                • "pattern": "(?<tag>.*)"
                }
              ],
            • "hashingPolicy": "standard"
            },
          • "security": {
            • "enableDefaultUser": true,
            • "sslClientAuthentication": false,
            • "tlsClientAuthentication": false,
            • "enableTls": false,
            • "sourceIps": [
              • "0.0.0.0/0"
              ]
            },
          • "modules": [
            • {
              • "id": 6652,
              • "name": "RediSearch",
              • "capabilityName": "Search and query",
              • "version": "2.0.11",
              • "description": "A comprehensive, expressive, flexible, fast and developer-friendly search and query engine for the diversity of data types in Redis with state-of-the-art scoring algorithms",
              • "parameters": [ ]
              }
            ],
          • "alerts": [ ],
          • "links": [ ]
          },
        • {
          • "databaseId": 3,
          • "name": "Redis-database-example-updated",
          • "protocol": "redis",
          • "provider": "AWS",
          • "region": "us-east-1",
          • "redisVersion": "7.4",
          • "status": "active",
          • "datasetSizeInGb": 2,
          • "memoryUsedInMb": 2,
          • "memoryStorage": "ram",
          • "supportOSSClusterApi": true,
          • "useExternalEndpointForOSSClusterApi": true,
          • "dataPersistence": "snapshot-every-1-hour",
          • "replication": false,
          • "dataEvictionPolicy": "noeviction",
          • "throughputMeasurement": {
            • "by": "operations-per-second",
            • "value": 2500
            },
          • "activatedOn": "2021-08-29T13:03:26Z",
          • "lastModified": "2021-08-29T13:03:26Z",
          • "publicEndpoint": "redis-19708.c235866.us-east-1-1.ec2.qa-cloud.rlrcp.com:19708",
          • "privateEndpoint": "redis-19708.internal.c235866.us-east-1-1.ec2.qa-cloud.rlrcp.com:19708",
          • "replica": {
            • "syncSources": [
              • {
                • "endpoint": "redis://localhost:6379",
                • "encryption": true,
                • "clientCert": "-----BEGIN CERTIFICATE-----\n ... -----END CERTIFICATE-----"
                }
              ]
            },
          • "clustering": {
            • "numberOfShards": 1,
            • "regexRules": [
              • {
                • "ordinal": 1,
                • "pattern": "(?<tag>.*)"
                },
              • {
                • "ordinal": 0,
                • "pattern": ".*\\{(?<tag>.*)\\}.*"
                }
              ],
            • "hashingPolicy": "standard"
            },
          • "security": {
            • "enableDefaultUser": false,
            • "sslClientAuthentication": false,
            • "tlsClientAuthentication": false,
            • "enableTls": false,
            • "sourceIps": [
              • "0.0.0.0/0"
              ]
            },
          • "modules": [
            • {
              • "id": 18536,
              • "name": "RedisJSON",
              • "capabilityName": "JSON",
              • "version": "2.0.6",
              • "description": "Native JSON Data Type for Redis, allowing for atomic reads and writes of sub-elements",
              • "parameters": [ ]
              }
            ],
          • "alerts": [ ],
          • "links": [ ]
          },
        • {
          • "databaseId": 4,
          • "name": "DB-RCP-2-81-6",
          • "protocol": "redis",
          • "provider": "AWS",
          • "region": "us-east-1",
          • "redisVersion": "7.4",
          • "status": "active",
          • "datasetSizeInGb": 2,
          • "memoryUsedInMb": 2,
          • "memoryStorage": "ram",
          • "supportOSSClusterApi": true,
          • "useExternalEndpointForOSSClusterApi": true,
          • "dataPersistence": "snapshot-every-1-hour",
          • "replication": false,
          • "dataEvictionPolicy": "noeviction",
          • "throughputMeasurement": {
            • "by": "operations-per-second",
            • "value": 25000
            },
          • "activatedOn": "2021-08-29T13:03:27Z",
          • "lastModified": "2021-08-29T13:03:27Z",
          • "publicEndpoint": "redis-14503.c235866.us-east-1-1.ec2.qa-cloud.rlrcp.com:14503",
          • "privateEndpoint": "redis-14503.internal.c235866.us-east-1-1.ec2.qa-cloud.rlrcp.com:14503",
          • "replica": {
            • "syncSources": [
              • {
                • "endpoint": "redis://localhost:6379",
                • "encryption": true,
                • "clientCert": "-----BEGIN CERTIFICATE-----\n ... -----END CERTIFICATE-----"
                }
              ]
            },
          • "clustering": {
            • "numberOfShards": 1,
            • "regexRules": [
              • {
                • "ordinal": 1,
                • "pattern": "(?<tag>.*)"
                },
              • {
                • "ordinal": 0,
                • "pattern": ".*\\{(?<tag>.*)\\}.*"
                }
              ],
            • "hashingPolicy": "standard"
            },
          • "security": {
            • "enableDefaultUser": true,
            • "sslClientAuthentication": false,
            • "tlsClientAuthentication": false,
            • "enableTls": false,
            • "sourceIps": [
              • "0.0.0.0/0"
              ]
            },
          • "modules": [
            • {
              • "id": 6653,
              • "name": "RedisTimeSeries",
              • "capabilityName": "Time series",
              • "version": "1.4.10",
              • "description": "Time-Series data structure for redis",
              • "parameters": [ ]
              }
            ],
          • "alerts": [ ],
          • "links": [ ]
          },
        • {
          • "databaseId": 5,
          • "name": "CI-tests-DO-NOT-DELETE",
          • "protocol": "redis",
          • "provider": "AWS",
          • "region": "us-east-1",
          • "redisVersion": "7.4",
          • "status": "active",
          • "datasetSizeInGb": 2,
          • "memoryUsedInMb": 4,
          • "memoryStorage": "ram",
          • "supportOSSClusterApi": false,
          • "useExternalEndpointForOSSClusterApi": false,
          • "dataPersistence": "none",
          • "replication": true,
          • "dataEvictionPolicy": "volatile-lru",
          • "throughputMeasurement": {
            • "by": "operations-per-second",
            • "value": 25000
            },
          • "activatedOn": "2021-08-29T13:03:22Z",
          • "lastModified": "2021-08-29T13:03:22Z",
          • "publicEndpoint": "redis-11349.c235866.us-east-1-1.ec2.qa-cloud.rlrcp.com:11349",
          • "privateEndpoint": "redis-11349.internal.c235866.us-east-1-1.ec2.qa-cloud.rlrcp.com:11349",
          • "replica": {
            • "syncSources": [
              • {
                • "endpoint": "redis://localhost:6379",
                • "encryption": true,
                • "clientCert": "-----BEGIN CERTIFICATE-----\n ... -----END CERTIFICATE-----"
                }
              ]
            },
          • "clustering": {
            • "numberOfShards": 1,
            • "regexRules": [ ],
            • "hashingPolicy": "standard"
            },
          • "security": {
            • "enableDefaultUser": true,
            • "sslClientAuthentication": false,
            • "tlsClientAuthentication": false,
            • "enableTls": false,
            • "sourceIps": [
              • "0.0.0.0/0"
              ]
            },
          • "modules": [ ],
          • "alerts": [ ],
          • "links": [ ]
          },
        • {
          • "databaseId": 6,
          • "name": "DB-RCP-2-81-4",
          • "protocol": "redis",
          • "provider": "AWS",
          • "region": "us-east-1",
          • "redisVersion": "7.4",
          • "status": "active",
          • "datasetSizeInGb": 2,
          • "memoryUsedInMb": 1,
          • "memoryStorage": "ram",
          • "supportOSSClusterApi": true,
          • "useExternalEndpointForOSSClusterApi": true,
          • "dataPersistence": "snapshot-every-1-hour",
          • "replication": false,
          • "dataEvictionPolicy": "noeviction",
          • "throughputMeasurement": {
            • "by": "operations-per-second",
            • "value": 25000
            },
          • "activatedOn": "2021-08-29T13:03:27Z",
          • "lastModified": "2021-08-29T13:03:27Z",
          • "publicEndpoint": "redis-13074.c235866.us-east-1-1.ec2.qa-cloud.rlrcp.com:13074",
          • "privateEndpoint": "redis-13074.internal.c235866.us-east-1-1.ec2.qa-cloud.rlrcp.com:13074",
          • "replica": {
            • "syncSources": [
              • {
                • "endpoint": "redis://localhost:6379",
                • "encryption": true,
                • "clientCert": "-----BEGIN CERTIFICATE-----\n ... -----END CERTIFICATE-----"
                }
              ]
            },
          • "clustering": {
            • "numberOfShards": 1,
            • "regexRules": [
              • {
                • "ordinal": 1,
                • "pattern": "(?<tag>.*)"
                },
              • {
                • "ordinal": 0,
                • "pattern": ".*\\{(?<tag>.*)\\}.*"
                }
              ],
            • "hashingPolicy": "standard"
            },
          • "security": {
            • "enableDefaultUser": true,
            • "sslClientAuthentication": false,
            • "tlsClientAuthentication": false,
            • "enableTls": false,
            • "sourceIps": [
              • "0.0.0.0/0"
              ]
            },
          • "modules": [
            • {
              • "id": 6651,
              • "name": "RediSearch",
              • "capabilityName": "Search and query",
              • "version": "2.0.11",
              • "description": "A comprehensive, expressive, flexible, fast and developer-friendly search and query engine for the diversity of data types in Redis with state-of-the-art scoring algorithms",
              • "parameters": [ ]
              }
            ],
          • "alerts": [ ],
          • "links": [ ]
          }
        ],
      • "links": [ ]
      }
    ],
  • "links": []
}

Import database

Import data from an RDB file or a different Redis database

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

databaseId
required
integer <int32>

Database Id

Request Body schema: application/json
required
sourceType
required
string
Enum: "http" "redis" "ftp" "aws-s3" "azure-blob-storage" "google-blob-storage"

Required. Type of storage source from which to import the database file (RDB files) or data (Redis connection)

importFromUri
required
Array of strings

Required. One or more URIs to source data files or Redis databases, as appropriate to specified source type (example: ['http://mydomain.com/redis-backup-file1', 'http://mydomain.com/redis-backup-file2'])

Responses

Request samples

Content type
application/json
{
  • "sourceType": "http",
  • "importFromUri": [
    • "string"
    ]
}

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Import database status

Information on the latest database import status identified by subscription Id and database Id

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

databaseId
required
integer <int32>

Database Id

Responses

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Override database tags

Override database tags for a given resource

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

databaseId
required
integer <int32>

Database Id

Request Body schema: application/json
required
required
Array of objects (tag)

Required. database tags

Responses

Request samples

Content type
application/json
{
  • "tags": [
    • {
      • "key": "environment",
      • "value": "production"
      }
    ]
}

Response samples

Content type
application/json
{
  • "accountId": 40131,
  • "tags": [
    • {
      • "key": "environment",
      • "value": "production",
      • "createdAt": "2024-05-21T20:02:21+02:00",
      • "updatedAt": "2024-06-21T20:02:21+02:00",
      • "links": [ ]
      },
    • {
      • "key": "owner",
      • "value": "Clifford O'neill",
      • "createdAt": "2024-05-21T20:02:21+02:00",
      • "updatedAt": "2024-06-21T20:02:21+02:00",
      • "links": [ ]
      }
    ],
  • "links": []
}

Update active-active regions

Update active-active local database properties

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

databaseId
required
integer <int32>

Database Id

Request Body schema: application/json
required
name
string

Optional. Database name (Database name must be up to 40 characters long, include only letters, digits, or hyphen ('-'), start with a letter, and end with a letter or digit)

dryRun
boolean

Optional. When 'false': Creates a deployment plan and deploys it (creating any resources required by the plan). When 'true': creates a read-only deployment plan without any resource creation. Default: 'false'

memoryLimitInGb
number <double> >= 0.1

Deprecated - Optional. Total memory including replication and other overhead

datasetSizeInGb
number <double> >= 0.1

Optional. The maximum amount of data in the dataset for this specific database is in GB. You can not set both datasetSizeInGb and totalMemoryInGb. if ‘replication’ is true, the database’s total memory will be twice as large as the datasetSizeInGb.if ‘replication’ is false, the database’s total memory of the database will be the datasetSizeInGb value.

supportOSSClusterApi
boolean

Optional. Support Redis open-source (OSS) Cluster API

useExternalEndpointForOSSClusterApi
boolean

Optional. Should use external endpoint for open-source (OSS) Cluster API. Can only be enabled if OSS Cluster API support is enabled. Default: 'false'

clientSslCertificate
string

Deprecated - Optional. A string containing TLS/SSL certificate (public key) with new line characters replaced by \n. If specified, mTLS authentication (with enableTls not specified or set to true) will be required to authenticate user connections. If empty string is received, SSL certificate will be removed and mTLS will not be required (note that TLS connection may still apply, depending on the value of the enableTls property). Default: 'null'"

Array of objects (DatabaseCertificateSpec)

Optional. A list of TLS/SSL certificates (public keys) with new line characters replaced by \n. If specified, mTLS authentication (with enableTls not specified or set to true) will be required to authenticate user connections. If empty list is received, SSL certificates will be removed and mTLS will not be required (note that TLS connection may still apply, depending on the value of the enableTls property). Default: 'null'"

enableTls
boolean

Optional. When 'true', requires TLS authentication for all connections (mTLS with valid clientSslCertificate, regular TLS when the clientSslCertificate is not provided)

globalDataPersistence
string
Enum: "none" "aof-every-1-second" "aof-every-write" "snapshot-every-1-hour" "snapshot-every-6-hours" "snapshot-every-12-hours"

Optional. Global rate of database data persistence (in persistent storage) of regions that dont override global settings. Default: 'none'

globalPassword
string

Optional. Password to access the database of regions that dont override global settings.

globalSourceIp
Array of strings

Optional. List of source IP addresses or subnet masks of regions that dont override global settings. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges (example: ['192.168.10.0/32', '192.168.12.0/24'] )

Array of objects (DatabaseAlertSpec)

Optional. Redis database alerts of regions that don't override global settings

Array of objects (LocalRegionProperties)

Optional. List or regions to update

dataEvictionPolicy
string
Enum: "allkeys-lru" "allkeys-lfu" "allkeys-random" "volatile-lru" "volatile-lfu" "volatile-random" "volatile-ttl" "noeviction"

Optional. Data items eviction method.

Responses

Request samples

Content type
application/json
{
  • "datasetSizeInGb": 5,
  • "regions": [
    • {
      • "region": "us-east-1",
      • "localThroughputMeasurement": {
        • "region": "us-east-1",
        • "writeOperationsPerSecond": 1000,
        • "readOperationsPerSecond": 2000
        },
      • "alerts": [
        • {
          • "name": "dataset-size",
          • "value": 80
          }
        ]
      }
    ],
  • "dataEvictionPolicy": "allkeys-lru"
}

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Update database

Update an existing database

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

databaseId
required
integer <int32>

Database Id

Request Body schema: application/json
required
dryRun
boolean

Optional. When 'false': Creates a deployment plan and deploys it (creating any resources required by the plan). When 'true': creates a read-only deployment plan without any resource creation. Default: 'false'

name
string

Optional. Database name

memoryLimitInGb
number <double> >= 0.1

Deprecated - Optional. Total memory including replication and other overhead

datasetSizeInGb
number <double> >= 0.1

Optional. The maximum amount of data in the dataset for this specific database is in GB. You can not set both datasetSizeInGb and totalMemoryInGb. if ‘replication’ is true, the database’s total memory will be twice as large as the datasetSizeInGb.if ‘replication’ is false, the database’s total memory of the database will be the datasetSizeInGb value.

respVersion
string
Enum: "resp2" "resp3"

Optional. RESP version must be compatible with Redis version.

object (DatabaseThroughputSpec)

Optional. Throughput measurement method. Default: 25000 ops/sec

dataPersistence
string
Enum: "none" "aof-every-1-second" "aof-every-write" "snapshot-every-1-hour" "snapshot-every-6-hours" "snapshot-every-12-hours"

Optional. Rate of database data persistence (in persistent storage)

dataEvictionPolicy
string
Enum: "allkeys-lru" "allkeys-lfu" "allkeys-random" "volatile-lru" "volatile-lfu" "volatile-random" "volatile-ttl" "noeviction"

Optional. Data items eviction method

replication
boolean

Optional. Databases replication

regexRules
Array of strings

Optional. Shard regex rules. Relevant only for a sharded database

replicaOf
Array of strings
Deprecated

Deprecated - Optional. This database will be a replica of the specified Redis databases provided as one or more URI (sample format: 'redis://user:password@host:port)'. If the URI provided is Redis Cloud instance, only host and port should be provided (using the format: ['redis://endpoint1:6379', 'redis://endpoint2:6380'] ).

object (ReplicaOfSpec)

Optional. Replica Of configuration

supportOSSClusterApi
boolean

Optional. Support Redis open-source (OSS) Cluster API

useExternalEndpointForOSSClusterApi
boolean

Optional. Should use external endpoint for open-source (OSS) Cluster API. Can only be enabled if OSS Cluster API support is enabled'. Default: 'false'

password
string

Optional. If specified, this password will be used to access the database. Can only be set if Database Protocol is REDIS

saslUsername
string

Optional. If specified, this Memcached (SASL) username will be used to access the database. Can only be set if Database Protocol is Memcached

saslPassword
string

Optional. If specified, this Memcached (SASL) password will be used to access the database. Can only be set if Database Protocol is Memcached

sourceIp
Array of strings

Optional. List of source IP addresses or subnet masks. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges (example: ['192.168.10.0/32', '192.168.12.0/24'] )

clientSslCertificate
string

Deprecated - Optional. A string containing TLS/SSL certificate (public key) with new line characters replaced by \n. If specified, mTLS authentication (with enableTls not specified or set to true) will be required to authenticate user connections. If empty string is received, SSL certificate will be removed and mTLS will not be required (note that TLS connection may still apply, depending on the value of the enableTls property). Default: 'null'"

Array of objects (DatabaseCertificateSpec)

Optional. A list of TLS/SSL certificates (public keys) with new line characters replaced by \n. If specified, mTLS authentication (with enableTls not specified or set to true) will be required to authenticate user connections. If empty list is received, SSL certificates will be removed and mTLS will not be required (note that TLS connection may still apply, depending on the value of the enableTls property). Default: 'null'"

enableTls
boolean

Optional. When 'true', requires TLS authentication for all connections (mTLS with valid clientSslCertificate, regular TLS when the clientSslCertificate is not provided). If enableTls is set to false it will also remove the mTLS requirement (by erasing the content of the clientSslCertificate property). Default: 'false'

enableDefaultUser
boolean

Optional. When 'true', enables connecting to the database with the 'default' user. Default: 'true'. Can only be set if Database Protocol is REDIS

periodicBackupPath
string

Deprecated - If specified, automatic backups will be every 24 hours or database will be able to perform immediate backups to this path. If empty string is received, backup path will be removed. Optional.

object (DatabaseBackupConfig)

Optional. Database remote backup configuration

Array of objects (DatabaseAlertSpec)

Optional. Redis database alerts

queryPerformanceFactor
string

Optional. The query performance factor adds extra compute power specifically for search and query. For databases with search and query, you can increase your search queries per second by the selected factor.

Responses

Request samples

Content type
application/json
{
  • "dryRun": false,
  • "name": "Redis-database-example",
  • "datasetSizeInGb": 5,
  • "throughputMeasurement": {
    • "by": "operations-per-second",
    • "value": 10000
    },
  • "dataPersistence": "none",
  • "dataEvictionPolicy": "allkeys-lru",
  • "alerts": [
    • {
      • "name": "dataset-size",
      • "value": 85
      }
    ]
}

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Update database tag by key

Update single database tag for a given resource by tag key

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

databaseId
required
integer <int32>

Database Id

tagKey
required
string

Tag key

Request Body schema: application/json
required
value
required
string

Required. database tag value

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
{}

Subscriptions - Essentials

All operations related to Essentials subscriptions lifecycle

Create Essentials subscription

Create a new Essentials subscription

Authorizations:
x-api-keyx-api-secret-key
Request Body schema: application/json
required
name
required
string

Essentials subscription name

planId
required
integer <int32>

A predefined Essentials plan Id (see lookup API '/fixed/plans'). The plan defines the billing, deployment and configuration for the created subscription based on specific plan details

paymentMethodId
integer <int32>

Optional. A valid payment method (credit card, wire transfer etc) pre-defined in the current account. It will be billed for any charges related to the created subscription.

Responses

Request samples

Content type
application/json
{
  • "name": "My new subscription",
  • "planId": 0,
  • "paymentMethodId": 0
}

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Delete Essentials subscription

Delete a Essentials subscription identified by subscription Id (subscription must be empty, i.e. cannot contain databases)

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

Responses

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Get Essentials subscription by id

Information on Essentials subscription identified by subscription Id

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

Responses

Response samples

Content type
application/json
{
  • "id": 151367,
  • "name": "fixed-sub-2",
  • "status": "active",
  • "paymentMethodId": 8241,
  • "paymentMethodType": "credit-card",
  • "planId": 98276,
  • "planName": "Standard 1GB",
  • "size": 1,
  • "sizeMeasurementUnit": "GB",
  • "provider": "AWS",
  • "region": "us-west-1",
  • "price": 22,
  • "pricePeriod": "Month",
  • "priceCurrency": "USD",
  • "maximumDatabases": 1,
  • "availability": "Single-zone",
  • "connections": "1024",
  • "cidrAllowRules": 8,
  • "supportDataPersistence": true,
  • "supportInstantAndDailyBackups": true,
  • "supportReplication": true,
  • "customerSupport": "Standard",
  • "creationDate": "2022-11-21T20:02:21+02:00",
  • "supportClustering": false,
  • "links": []
}

Get Essentials subscription plan by id

Information on a specific Essentials subscription plan identified by plan Id

Authorizations:
x-api-keyx-api-secret-key
path Parameters
planId
required
integer <int32>

Essentials Subscription Plan ID

Responses

Response samples

Content type
application/json
{
  • "id": 98273,
  • "name": "Cache 5GB",
  • "size": 5,
  • "sizeMeasurementUnit": "GB",
  • "provider": "AWS",
  • "region": "eu-west-1",
  • "regionId": 4,
  • "price": 77,
  • "priceCurrency": "USD",
  • "pricePeriod": "Month",
  • "maximumDatabases": 1,
  • "availability": "No replication",
  • "connections": "unlimited",
  • "cidrAllowRules": 4,
  • "supportDataPersistence": true,
  • "supportInstantAndDailyBackups": true,
  • "supportReplication": false,
  • "supportClustering": true,
  • "supportSsl": false,
  • "supportedAlerts": [
    • "throughput-higher-than"
    ],
  • "customerSupport": "Standard",
  • "links": []
}

Get Essentials subscription plans by subscription id

Lookup list of Essentials plans that can be used by a specific subscription

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

Responses

Response samples

Content type
application/json
{
  • "plans": [
    • {
      • "id": 98183,
      • "name": "Multi-AZ 5GB",
      • "size": 5,
      • "sizeMeasurementUnit": "GB",
      • "provider": "AWS",
      • "region": "us-east-1",
      • "regionId": 1,
      • "price": 100,
      • "priceCurrency": "USD",
      • "pricePeriod": "Month",
      • "maximumDatabases": 1,
      • "availability": "Multi-zone",
      • "connections": "unlimited",
      • "cidrAllowRules": 16,
      • "supportDataPersistence": true,
      • "supportInstantAndDailyBackups": true,
      • "supportReplication": true,
      • "supportClustering": false,
      • "supportSsl": true,
      • "supportedAlerts": [
        • "datasets-size",
        • "latency",
        • "throughput-lower-than",
        • "throughput-higher-than"
        ],
      • "customerSupport": "Standard",
      • "links": [ ]
      },
    • {
      • "id": 98181,
      • "name": "Multi-AZ 1GB",
      • "size": 1,
      • "sizeMeasurementUnit": "GB",
      • "provider": "AWS",
      • "region": "us-east-1",
      • "regionId": 1,
      • "price": 22,
      • "priceCurrency": "USD",
      • "pricePeriod": "Month",
      • "maximumDatabases": 1,
      • "availability": "Multi-zone",
      • "connections": "1024",
      • "cidrAllowRules": 8,
      • "supportDataPersistence": true,
      • "supportInstantAndDailyBackups": true,
      • "supportReplication": true,
      • "supportClustering": false,
      • "supportSsl": true,
      • "supportedAlerts": [
        • "datasets-size",
        • "throughput-higher-than",
        • "throughput-lower-than",
        • "latency",
        • "connections-limit"
        ],
      • "customerSupport": "Standard",
      • "links": [ ]
      }
    ],
  • "links": []
}

Get Essentials subscriptions

Information on current account's Essentials subscriptions

Authorizations:
x-api-keyx-api-secret-key

Responses

Response samples

Content type
application/json
{
  • "accountId": 40131,
  • "subscriptions": [
    • {
      • "id": 151367,
      • "name": "fixed-1",
      • "status": "active",
      • "paymentMethodId": 8241,
      • "paymentMethodType": "credit-card",
      • "planId": 98276,
      • "planName": "Standard 1GB",
      • "size": 1,
      • "sizeMeasurementUnit": "GB",
      • "provider": "AWS",
      • "region": "us-west-1",
      • "price": 22,
      • "pricePeriod": "Month",
      • "priceCurrency": "USD",
      • "maximumDatabases": 1,
      • "availability": "Single-zone",
      • "connections": "1024",
      • "cidrAllowRules": 8,
      • "supportDataPersistence": true,
      • "supportInstantAndDailyBackups": true,
      • "supportReplication": true,
      • "supportClustering": false,
      • "customerSupport": "Standard",
      • "creationDate": "2022-11-21T20:02:21+02:00",
      • "links": [ ]
      },
    • {
      • "id": 120416,
      • "name": "subscription-name",
      • "status": "active",
      • "paymentMethodId": 123,
      • "paymentMethodType": "credit-card",
      • "planId": 123,
      • "planName": "Standard 30MB",
      • "planType": "pay-as-you-go",
      • "size": 30,
      • "sizeMeasurementUnit": "MB",
      • "provider": "AWS",
      • "region": "us-east-1",
      • "price": 0,
      • "pricePeriod": "Month",
      • "priceCurrency": "USD",
      • "maximumDatabases": 1,
      • "availability": "no-replication",
      • "connections": 30,
      • "cidrAllowRules": 1,
      • "supportDataPersistence": false,
      • "supportInstantAndDailyBackups": false,
      • "supportReplication": false,
      • "supportClustering": false,
      • "customerSupport": "basic",
      • "creationDate": "20-Nov-2022",
      • "links": [ ]
      }
    ],
  • "links": []
}

Get Plans

Lookup list of plans

Authorizations:
x-api-keyx-api-secret-key
query Parameters
provider
string
Enum: "AWS" "GCP" "AZURE"

Cloud Provider Name

redisFlex
boolean

Is RedisFlex Plan

Responses

Response samples

Content type
application/json
{
  • "plans": [
    • {
      • "id": 98183,
      • "name": "Multi-AZ 5GB",
      • "size": 5,
      • "sizeMeasurementUnit": "GB",
      • "provider": "AWS",
      • "region": "us-east-1",
      • "regionId": 1,
      • "price": 100,
      • "priceCurrency": "USD",
      • "pricePeriod": "Month",
      • "maximumDatabases": 1,
      • "availability": "Multi-zone",
      • "connections": "unlimited",
      • "cidrAllowRules": 16,
      • "supportDataPersistence": true,
      • "supportInstantAndDailyBackups": true,
      • "supportReplication": true,
      • "supportClustering": false,
      • "supportSsl": true,
      • "supportedAlerts": [
        • "datasets-size",
        • "latency",
        • "throughput-lower-than",
        • "throughput-higher-than"
        ],
      • "customerSupport": "Standard",
      • "links": [ ]
      },
    • {
      • "id": 98181,
      • "name": "Multi-AZ 1GB",
      • "size": 1,
      • "sizeMeasurementUnit": "GB",
      • "provider": "AWS",
      • "region": "us-east-1",
      • "regionId": 1,
      • "price": 22,
      • "priceCurrency": "USD",
      • "pricePeriod": "Month",
      • "maximumDatabases": 1,
      • "availability": "Multi-zone",
      • "connections": "1024",
      • "cidrAllowRules": 8,
      • "supportDataPersistence": true,
      • "supportInstantAndDailyBackups": true,
      • "supportReplication": true,
      • "supportClustering": false,
      • "supportSsl": true,
      • "supportedAlerts": [
        • "datasets-size",
        • "throughput-higher-than",
        • "throughput-lower-than",
        • "latency",
        • "connections-limit"
        ],
      • "customerSupport": "Standard",
      • "links": [ ]
      }
    ],
  • "links": []
}

Update Essentials subscription

Update an Essentials subscription

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>
Request Body schema: application/json
required
name
string

Optional. Essentials subscription name

planId
integer <int32>

Optional. A predefined Essentials plan Id (see lookup API '/fixed/plans'). The plan defines the billing, deployment and configuration for the created subscription based on specific plan details

paymentMethodId
integer <int32>

Optional. A valid payment method (credit card, wire transfer etc) pre-defined in the current account. It will be billed for any charges related to the created subscription.

Responses

Request samples

Content type
application/json
{
  • "name": "My new subscription",
  • "planId": 0,
  • "paymentMethodId": 0
}

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Databases - Essentials

All operations related to Essentials databases lifecycle

Add database tags

Add single database tag for a given resource

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

databaseId
required
integer <int32>

Database Id

Request Body schema: application/json
required
key
required
string

Required. Database tag key

value
required
string

Required. Database tag value

Responses

Request samples

Content type
application/json
{
  • "key": "environment",
  • "value": "production"
}

Response samples

Content type
application/json
{}

Backup Essentials database

Manually backup an Essentials database into the destination defined for it

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

databaseId
required
integer <int32>

Database Id

Request Body schema: application/json
adhocBackupPath
string

Optional. Path for ad-hoc backup.

Responses

Request samples

Content type
application/json
{
  • "adhocBackupPath": "s3://<backup-path>"
}

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Backup Essentials database status

Information on the latest database backup status identified by Essentials subscription Id and Essentials database Id

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

databaseId
required
integer <int32>

Database Id

Responses

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Create Essentials database

Create a new Essentials database

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

Request Body schema: application/json
required
name
required
string

Required. Database name (Database name must be up to 40 characters long, include only letters, digits, or hyphen ('-'), start with a letter, and end with a letter or digit)

protocol
string
Enum: "redis" "memcached" "stack"

Optional. Database protocol. 'stack' is a suite of all Redis’ data modules. Default: 'stack', for Redis Flex subscription Default: 'redis'. 'redis' is only used with Pay-As-You-Go subscriptions and with Redis Flex.

memoryLimitInGb
number <double> >= 0.1

Deprecated - Optional. Total memory including replication and other overhead. Supported only for 'Pay-As-You-Go' subscriptions

datasetSizeInGb
number <double> >= 0.1

Optional. The maximum amount of data in the dataset for this specific database is in GB. You can not set both datasetSizeInGb and totalMemoryInGb. if 'replication' is true, the database’s total memory will be twice as large as the datasetSizeInGb.if 'replication' is false, the database’s total memory of the database will be the datasetSizeInGb value.

supportOSSClusterApi
boolean

Optional. Support Redis open-source (OSS) Cluster API. Supported only for 'Pay-As-You-Go' subscriptions

respVersion
string
Enum: "resp2" "resp3"

Optional. RESP version must be compatible with Redis version.

useExternalEndpointForOSSClusterApi
boolean

Optional. Should use external endpoint for open-source (OSS) Cluster API. Can only be enabled if OSS Cluster API support is enabled. Supported only for 'Pay-As-You-Go' subscriptions

enableDatabaseClustering
boolean

Optional. Distributes database data to different cloud instances. Supported only for 'Pay-As-You-Go' subscriptions

numberOfShards
integer <int32>

Optional. Specifies the number of master shards. Supported only for 'Pay-As-You-Go' subscriptions

dataPersistence
string
Enum: "none" "aof-every-1-second" "aof-every-write" "snapshot-every-1-hour" "snapshot-every-6-hours" "snapshot-every-12-hours"

Optional. Rate of database data persistence (in persistent storage). The default is according to the subscription plan.

dataEvictionPolicy
string
Enum: "allkeys-lru" "allkeys-lfu" "allkeys-random" "volatile-lru" "volatile-lfu" "volatile-random" "volatile-ttl" "noeviction"

Optional. Data items eviction method

replication
boolean

Optional. Databases replication. The default is according to the subscription plan.

periodicBackupPath
string

Optional. If specified, automatic backups will be every 24 hours or database will be able to perform immediate backups to this path. If empty string is received, backup path will be removed. Optional.

sourceIps
Array of strings

Optional. List of source IP addresses or subnet masks. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges. example value: '['192.168.10.0/32', '192.168.12.0/24']'

regexRules
Array of strings

Optional. Shard regex rules. Relevant only for a sharded database. Supported only for 'Pay-As-You-Go' subscriptions

replicaOf
Array of strings
Deprecated

Deprecated - Optional. This database will be a replica of the specified Redis databases provided as one or more URI (sample format: 'redis://user:password@host:port)'. If the URI provided is Redis Cloud instance, only host and port should be provided (using the format: ['redis://endpoint1:6379', 'redis://endpoint2:6380'] ).

object (ReplicaOfSpec)

Optional. Replica Of configuration

clientSslCertificate
string

Deprecated - Optional. A string containing TLS/SSL certificate (public key) with new line characters replaced by \n. If specified, mTLS authentication (with enableTls not specified or set to true) will be required to authenticate user connections. If empty string is received, SSL certificate will be removed and mTLS will not be required (note that TLS connection may still apply, depending on the value of the enableTls property). Default: 'null'"

Array of objects (DatabaseCertificateSpec)

Optional. A list of TLS/SSL certificates (public keys) with new line characters replaced by \n. If specified, mTLS authentication (with enableTls not specified or set to true) will be required to authenticate user connections. If empty list is received, SSL certificates will be removed and mTLS will not be required (note that TLS connection may still apply, depending on the value of the enableTls property). Default: 'null'"

enableTls
boolean

Optional. When 'true', requires TLS authentication for all connections (mTLS with valid clientSslCertificate, regular TLS when the clientSslCertificate is not provided).

password
string

Optional. Password to access the database. If omitted, a random 32 character long alphanumeric password will be automatically generated

Array of objects (DatabaseAlertSpec)

Optional. Redis database alerts

Array of objects (DatabaseModuleSpec)

Optional. Redis modules to be provisioned in the database

Responses

Request samples

Content type
application/json
{
  • "name": "Redis-fixed-database-example",
  • "protocol": "stack",
  • "dataPersistence": "none",
  • "dataEvictionPolicy": "allkeys-lru",
  • "replication": true,
  • "alerts": [
    • {
      • "name": "datasets-size",
      • "value": 80
      }
    ]
}

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Delete database tag by key

Delete database tag for a given resource by tag key

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

databaseId
required
integer <int32>

Database Id

tagKey
required
string
Example: environment

Tag key

Responses

Response samples

Content type
application/json
{ }

Delete Essentials database

Delete a specific database identified by an Essentials subscription Id and database Id

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

databaseId
required
integer <int32>

Database Id

Responses

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Get database tags

Get database tags for a given resource

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

databaseId
required
integer <int32>

Database Id

Responses

Response samples

Content type
application/json
{
  • "accountId": 40131,
  • "tags": [
    • {
      • "key": "environment",
      • "value": "production",
      • "createdAt": "2024-05-21T20:02:21+02:00",
      • "updatedAt": "2024-06-21T20:02:21+02:00",
      • "links": [ ]
      },
    • {
      • "key": "owner",
      • "value": "Clifford O'neill",
      • "createdAt": "2024-05-21T20:02:21+02:00",
      • "updatedAt": "2024-06-21T20:02:21+02:00",
      • "links": [ ]
      }
    ],
  • "links": []
}

Get Essentials database by id

Information on a specific database identified by Essentials subscription Id and database Id

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32> >= 0

Subscription Id

databaseId
required
integer <int32> >= 0

Database Id

Responses

Response samples

Content type
application/json
{
  • "databaseId": 51324587,
  • "name": "bdb",
  • "protocol": "stack",
  • "provider": "AWS",
  • "region": "us-east-1",
  • "status": "draft",
  • "planMemoryLimit": 250,
  • "respVersion": "resp2",
  • "memoryLimitMeasurementUnit": "MB",
  • "memoryUsedInMb": 7,
  • "memoryStorage": "ram",
  • "dataPersistence": "none",
  • "replication": true,
  • "dataEvictionPolicy": "noeviction",
  • "clustering": {
    • "enabled": false,
    • "regexRules": [
      • {
        • "ordinal": 0,
        • "pattern": ".*\\{(?<tag>.*)\\}.*"
        },
      • {
        • "ordinal": 1,
        • "pattern": "(?<tag>.*)"
        }
      ],
    • "hashingPolicy": "standard"
    },
  • "security": {
    • "defaultUserEnabled": true,
    • "password": "myCustomPassword",
    • "sourceIps": [
      • "0.0.0.0/0"
      ]
    },
  • "modules": [
    • {
      • "id": 18534,
      • "name": "RediSearch",
      • "capabilityName": "Search and query",
      • "version": "2.2.6",
      • "description": "A comprehensive, expressive, flexible, fast and developer-friendly search and query engine for the diversity of data types in Redis with state-of-the-art scoring algorithms",
      • "parameters": [ ]
      },
    • {
      • "id": 18535,
      • "name": "RedisBloom",
      • "capabilityName": "Probabilistic",
      • "version": "2.2.12",
      • "description": "A set of probabilistic data structures to Redis, including Bloom filter, Cuckoo filter, Count-min sketch, Top-K, and t-digest",
      • "parameters": [ ]
      },
    • {
      • "id": 18536,
      • "name": "RedisJSON",
      • "capabilityName": "JSON",
      • "version": "2.0.6",
      • "description": "Native JSON Data Type for Redis, allowing for atomic reads and writes of sub-elements",
      • "parameters": [ ]
      },
    • {
      • "id": 18537,
      • "name": "RedisTimeSeries",
      • "capabilityName": "Time series",
      • "version": "1.6.8",
      • "description": "Time-Series data structure for Redis",
      • "parameters": [ ]
      }
    ],
  • "alerts": [
    • {
      • "name": "connections-limit",
      • "value": 80,
      • "defaultValue": 80
      }
    ],
  • "backup": {
    • "remoteBackupEnabled": false
    },
  • "links": [ ]
}

Get Essentials databases

Information on databases belonging to an Essentials subscription identified by subscription Id

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32> >= 0

Subscription Id

query Parameters
offset
integer <int32>

Number of items to skip

limit
integer <int32>
Example: limit=100

Maximum number of items to return

Responses

Response samples

Content type
application/json
{
  • "accountId": 40131,
  • "subscription": {
    • "subscriptionId": 154714,
    • "numberOfDatabases": 2,
    • "databases": [
      • {
        • "databaseId": 51324587,
        • "name": "bdb",
        • "protocol": "stack",
        • "provider": "AWS",
        • "region": "us-east-1",
        • "redisVersion": "7.4",
        • "status": "draft",
        • "planMemoryLimit": 250,
        • "respVersion": "resp2",
        • "memoryLimitMeasurementUnit": "MB",
        • "memoryUsedInMb": 1,
        • "memoryStorage": "ram",
        • "dataPersistence": "none",
        • "replication": true,
        • "dataEvictionPolicy": "noeviction",
        • "clustering": {
          • "enabled": false,
          • "regexRules": [
            • {
              • "ordinal": 0,
              • "pattern": ".*\\{(?<tag>.*)\\}.*"
              },
            • {
              • "ordinal": 1,
              • "pattern": "(?<tag>.*)"
              }
            ],
          • "hashingPolicy": "standard"
          },
        • "security": {
          • "defaultUserEnabled": true,
          • "sourceIps": [
            • "0.0.0.0/0"
            ]
          },
        • "modules": [
          • {
            • "id": 18534,
            • "name": "searchlight",
            • "capabilityName": "Search and query",
            • "version": "2.2.6",
            • "description": "A comprehensive, expressive, flexible, fast and developer-friendly search and query engine for the diversity of data types in Redis with state-of-the-art scoring algorithms",
            • "parameters": [ ]
            },
          • {
            • "id": 18535,
            • "name": "RedisBloom",
            • "capabilityName": "Probabilistic",
            • "version": "2.2.12",
            • "description": "A set of probabilistic data structures to Redis, including Bloom filter, Cuckoo filter, Count-min sketch, Top-K, and t-digest",
            • "parameters": [ ]
            },
          • {
            • "id": 18536,
            • "name": "RedisJSON",
            • "capabilityName": "JSON",
            • "version": "2.0.6",
            • "description": "Native JSON Data Type for Redis, allowing for atomic reads and writes of sub-elements",
            • "parameters": [ ]
            },
          • {
            • "id": 18537,
            • "name": "RedisTimeSeries",
            • "capabilityName": "Time series",
            • "version": "1.6.8",
            • "description": "Time-Series data structure for Redis",
            • "parameters": [ ]
            }
          ],
        • "alerts": [
          • {
            • "name": "connections-limit",
            • "value": 80,
            • "defaultValue": 80
            }
          ],
        • "backup": {
          • "remoteBackupEnabled": false
          },
        • "links": [ ]
        },
      • {
        • "databaseId": 51324586,
        • "name": "firstDB",
        • "protocol": "stack",
        • "provider": "AWS",
        • "region": "us-east-1",
        • "status": "draft",
        • "planMemoryLimit": 250,
        • "memoryLimitMeasurementUnit": "MB",
        • "memoryUsedInMb": 1,
        • "memoryStorage": "ram",
        • "dataPersistence": "none",
        • "replication": true,
        • "dataEvictionPolicy": "noeviction",
        • "clustering": {
          • "enabled": false,
          • "regexRules": [
            • {
              • "ordinal": 0,
              • "pattern": ".*\\{(?<tag>.*)\\}.*"
              },
            • {
              • "ordinal": 1,
              • "pattern": "(?<tag>.*)"
              }
            ],
          • "hashingPolicy": "standard"
          },
        • "security": {
          • "defaultUserEnabled": true,
          • "sourceIps": [
            • "0.0.0.0/0"
            ]
          },
        • "modules": [
          • {
            • "id": 18529,
            • "name": "searchlight",
            • "capabilityName": "Search and query",
            • "version": "2.2.6",
            • "description": "A comprehensive, expressive, flexible, fast and developer-friendly search and query engine for the diversity of data types in Redis with state-of-the-art scoring algorithms",
            • "parameters": [ ]
            },
          • {
            • "id": 18530,
            • "name": "RedisBloom",
            • "capabilityName": "Probabilistic",
            • "version": "2.2.12",
            • "description": "A set of probabilistic data structures to Redis, including Bloom filter, Cuckoo filter, Count-min sketch, Top-K, and t-digest",
            • "parameters": [ ]
            },
          • {
            • "id": 18531,
            • "name": "RedisJSON",
            • "capabilityName": "JSON",
            • "version": "2.0.6",
            • "description": "Native JSON Data Type for Redis, allowing for atomic reads and writes of sub-elements",
            • "parameters": [ ]
            },
          • {
            • "id": 18532,
            • "name": "RedisTimeSeries",
            • "capabilityName": "Time series",
            • "version": "1.6.8",
            • "description": "Time-Series data structure for Redis",
            • "parameters": [ ]
            }
          ],
        • "alerts": [
          • {
            • "name": "connections-limit",
            • "value": 80,
            • "defaultValue": 80
            }
          ],
        • "backup": {
          • "remoteBackupEnabled": false
          },
        • "links": [ ]
        }
      ],
    • "links": [ ]
    },
  • "links": [ ]
}

Import Essentials database

Import data from an RDB file or a different Redis database

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

databaseId
required
integer <int32>

Database Id

Request Body schema: application/json
required
sourceType
required
string
Enum: "http" "redis" "ftp" "aws-s3" "azure-blob-storage" "google-blob-storage"

Required. Type of storage source from which to import the database file (RDB files) or data (Redis connection)

importFromUri
required
Array of strings

Required. One or more URIs to source data files or Redis databases, as appropriate to specified source type (example: ['http://mydomain.com/redis-backup-file1', 'http://mydomain.com/redis-backup-file2'])

Responses

Request samples

Content type
application/json
{
  • "sourceType": "http",
  • "importFromUri": [
    • "string"
    ]
}

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Import Essentials database status

Information on the latest database import status identified by Essentials subscription Id and Essentials database Id

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

databaseId
required
integer <int32>

Database Id

Responses

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Override database tags

Override database tags for a given resource

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

databaseId
required
integer <int32>

Database Id

Request Body schema: application/json
required
required
Array of objects (tag)

Required. database tags

Responses

Request samples

Content type
application/json
{
  • "tags": [
    • {
      • "key": "environment",
      • "value": "production"
      }
    ]
}

Response samples

Content type
application/json
{
  • "accountId": 40131,
  • "tags": [
    • {
      • "key": "environment",
      • "value": "production",
      • "createdAt": "2024-05-21T20:02:21+02:00",
      • "updatedAt": "2024-06-21T20:02:21+02:00",
      • "links": [ ]
      },
    • {
      • "key": "owner",
      • "value": "Clifford O'neill",
      • "createdAt": "2024-05-21T20:02:21+02:00",
      • "updatedAt": "2024-06-21T20:02:21+02:00",
      • "links": [ ]
      }
    ],
  • "links": []
}

Update database tag by key

Update single database tag for a given resource by tag key

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

databaseId
required
integer <int32>

Database Id

tagKey
required
string

Tag key

Request Body schema: application/json
required
value
required
string

Required. database tag value

Responses

Request samples

Content type
application/json
{
  • "value": "string"
}

Response samples

Content type
application/json
{}

Update Essentials database

Update a specific database identified by an Essentials subscription Id and database Id

Authorizations:
x-api-keyx-api-secret-key
path Parameters
subscriptionId
required
integer <int32>

Subscription Id

databaseId
required
integer <int32>

Database Id

Request Body schema: application/json
required
name
string

Optional. Database name (Database name must be up to 40 characters long, include only letters, digits, or hyphen ('-'), start with a letter, and end with a letter or digit)

memoryLimitInGb
number <double> >= 0.1

Deprecated - Optional. Total memory including replication and other overhead. Supported only for 'Pay-As-You-Go' subscriptions

datasetSizeInGb
number <double> >= 0.1

Optional. The maximum amount of data in the dataset for this specific database is in GB. You can not set both datasetSizeInGb and totalMemoryInGb. if ‘replication’ is true, the database’s total memory will be twice as large as the datasetSizeInGb.if ‘replication’ is false, the database’s total memory of the database will be the datasetSizeInGb value.

supportOSSClusterApi
boolean

Optional. Support Redis open-source (OSS) Cluster API. Supported only for 'Pay-As-You-Go' subscriptions

respVersion
string
Enum: "resp2" "resp3"

Optional. RESP version must be compatible with Redis version.

useExternalEndpointForOSSClusterApi
boolean

Optional. Should use external endpoint for open-source (OSS) Cluster API. Can only be enabled if OSS Cluster API support is enabled. Supported only for 'Pay-As-You-Go' subscriptions

enableDatabaseClustering
boolean

Optional. Distributes database data to different cloud instances. Default: 'false'. Supported only for 'Pay-As-You-Go' subscriptions

numberOfShards
integer <int32>

Optional. Specifies the number of master shards. Supported only for 'Pay-As-You-Go' subscriptions

dataPersistence
string
Enum: "none" "aof-every-1-second" "aof-every-write" "snapshot-every-1-hour" "snapshot-every-6-hours" "snapshot-every-12-hours"

Optional. Rate of database data persistence (in persistent storage)

dataEvictionPolicy
string
Enum: "allkeys-lru" "allkeys-lfu" "allkeys-random" "volatile-lru" "volatile-lfu" "volatile-random" "volatile-ttl" "noeviction"

Optional. Data items eviction method

replication
boolean

Optional. Databases replication

periodicBackupPath
string

Optional. If specified, automatic backups will be every 24 hours or database will be able to perform immediate backups to this path. If empty string is received, backup path will be removed. Optional.

sourceIps
Array of strings

Optional. List of source IP addresses or subnet masks. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges. example value: '['192.168.10.0/32', '192.168.12.0/24']'

replicaOf
Array of strings
Deprecated

Deprecated - Optional. This database will be a replica of the specified Redis databases provided as one or more URI (sample format: 'redis://user:password@host:port)'. If the URI provided is Redis Cloud instance, only host and port should be provided (using the format: ['redis://endpoint1:6379', 'redis://endpoint2:6380'] ).

object (ReplicaOfSpec)

Optional. Replica Of configuration

regexRules
Array of strings

Optional. Shard regex rules. Relevant only for a sharded database. Supported only for 'Pay-As-You-Go' subscriptions

clientSslCertificate
string

Deprecated - Optional. A string containing TLS/SSL certificate (public key) with new line characters replaced by \n. If specified, mTLS authentication (with enableTls not specified or set to true) will be required to authenticate user connections. If empty string is received, SSL certificate will be removed and mTLS will not be required (note that TLS connection may still apply, depending on the value of the enableTls property). Default: 'null'"

Array of objects (DatabaseCertificateSpec)

Optional. A list of TLS/SSL certificates (public keys) with new line characters replaced by \n. If specified, mTLS authentication (with enableTls not specified or set to true) will be required to authenticate user connections. If empty list is received, SSL certificates will be removed and mTLS will not be required (note that TLS connection may still apply, depending on the value of the enableTls property). Default: 'null'"

enableTls
boolean

Optional. When 'true', requires TLS authentication for all connections (mTLS with valid clientSslCertificate, regular TLS when the clientSslCertificate is not provided).

password
string

Optional. Password to access the database. If omitted, a random 32 character long alphanumeric password will be automatically generated

enableDefaultUser
boolean

Optional. When 'true', enables connecting to the database with the 'default' user. Default: 'true'

Array of objects (DatabaseAlertSpec)

Optional. Redis database alerts

Responses

Request samples

Content type
application/json
{
  • "name": "Redis-fixed-database-example",
  • "dataPersistence": "none",
  • "dataEvictionPolicy": "allkeys-lru",
  • "replication": true,
  • "enableDefaultUser": true,
  • "alerts": [
    • {
      • "name": "datasets-size",
      • "value": 80
      }
    ]
}

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Access Control List

Data and operations related to access control list

Create ACL redis rule

Create a new ACL redis rule

Authorizations:
x-api-keyx-api-secret-key
Request Body schema: application/json
required
name
required
string

Required. ACL redis rule name

redisRule
required
string

Required. ACL redis rule pattern

Responses

Request samples

Content type
application/json
{
  • "name": "ACL-rule-example",
  • "redisRule": "string"
}

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Create ACL role

Create a new ACL role

Authorizations:
x-api-keyx-api-secret-key
Request Body schema: application/json
required
name
required
string

Required. ACL role name

required
Array of objects (AclRoleRedisRuleSpec)

Required. List of ACL redis rules to associated with the requested ACL role

Responses

Request samples

Content type
application/json
{
  • "name": "ACL-role-example",
  • "redisRules": [
    • {
      • "ruleName": "Read-Only",
      • "databases": [
        • {
          • "subscriptionId": 0,
          • "databaseId": 0,
          • "regions": [ ]
          }
        ]
      }
    ]
}

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Create ACL user

Create a new ACL user

Authorizations:
x-api-keyx-api-secret-key
Request Body schema: application/json
required
name
required
string

Required. ACL user name

role
required
string

Required. ACL role name

password
required
string

Required. Password to identify as user after creation.

Responses

Request samples

Content type
application/json
{
  • "name": "ACL-user-example",
  • "role": "Redis-role-example",
  • "password": "some-random-password"
}

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Delete ACL redis rule

Delete an ACL redis rule

Authorizations:
x-api-keyx-api-secret-key
path Parameters
aclRedisRuleId
required
integer <int32>

ACL redis rule ID

Responses

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Delete ACL role

Delete an ACL role

Authorizations:
x-api-keyx-api-secret-key
path Parameters
aclRoleId
required
integer <int32>

ACL role ID

Responses

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Delete ACL user

Delete an ACL user

Authorizations:
x-api-keyx-api-secret-key
path Parameters
aclUserId
required
integer <int32>

ACL user ID

Responses

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Get ACL redis rules

Information on current account's ACL users

Authorizations:
x-api-keyx-api-secret-key

Responses

Response samples

Content type
application/json
{
  • "accountId": 1001,
  • "redisRules": [
    • {
      • "id": 7,
      • "name": "Full-Access",
      • "acl": "+@all ~*",
      • "isDefault": true,
      • "status": "active"
      },
    • {
      • "id": 8,
      • "name": "Read-Write",
      • "acl": "+@all -@dangerous ~*",
      • "isDefault": true,
      • "status": "active"
      },
    • {
      • "id": 9,
      • "name": "Read-Only",
      • "acl": "+@read ~*",
      • "isDefault": true,
      • "status": "active"
      }
    ]
}

Get ACL roles

Information on current account's ACL roles

Authorizations:
x-api-keyx-api-secret-key

Responses

Response samples

Content type
application/json
{
  • "accountId": 1001,
  • "roles": [
    • {
      • "id": 395,
      • "name": "role-name",
      • "redisRules": [
        • {
          • "ruleId": 7,
          • "ruleName": "Full-Access",
          • "databases": [
            • {
              • "subscriptionId": 126,
              • "databaseId": 1,
              • "databaseName": "DB-RCP-2-81-7"
              }
            ]
          }
        ],
      • "users": [ ],
      • "status": "error"
      }
    ]
}

Get ACL user by id

Information on an ACL user identified by ACL user Id

Authorizations:
x-api-keyx-api-secret-key
path Parameters
aclUserId
required
integer <int32> >= 0

ACL user ID

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "abc",
  • "role": "role-name",
  • "status": "active"
}

Get ACL users

Information on current account's ACL users

Authorizations:
x-api-keyx-api-secret-key

Responses

Response samples

Content type
application/json
{
  • "accountId": 1001,
  • "users": [
    • {
      • "id": 1,
      • "name": "user",
      • "role": "role-name",
      • "status": "active",
      • "links": [ ]
      }
    ]
}

Update ACL redis rule

Update an ACL redis rule

Authorizations:
x-api-keyx-api-secret-key
path Parameters
aclRedisRuleId
required
integer <int32>

ACL redis rule ID

Request Body schema: application/json
required
name
required
string

Optional. ACL redis rule name

redisRule
required
string

Optional. ACL redis rule pattern

Responses

Request samples

Content type
application/json
{
  • "name": "ACL-rule-example",
  • "redisRule": "string"
}

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Update ACL role

Update an ACL role

Authorizations:
x-api-keyx-api-secret-key
path Parameters
aclRoleId
required
integer <int32>

ACL role ID

Request Body schema: application/json
required
name
string

Optional. ACL role name

Array of objects (AclRoleRedisRuleSpec)

Optional. List of ACL redis rules to associated with the requested ACL role

Responses

Request samples

Content type
application/json
{
  • "name": "ACL-role-example",
  • "redisRules": [
    • {
      • "ruleName": "Read-Only",
      • "databases": [
        • {
          • "subscriptionId": 0,
          • "databaseId": 0,
          • "regions": [ ]
          }
        ]
      }
    ]
}

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Update ACL user

Update a new ACL user

Authorizations:
x-api-keyx-api-secret-key
path Parameters
aclUserId
required
integer <int32>

ACL user ID

Request Body schema: application/json
required
role
string

Optional. ACL role name

password
string

Optional. ACL User's password.

Responses

Request samples

Content type
application/json
{
  • "role": "Redis-role-example",
  • "password": "some-random-password"
}

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Cloud Accounts

All operations related to cloud accounts (AWS only)

Create cloud account

Create cloud account

Authorizations:
x-api-keyx-api-secret-key
Request Body schema: application/json
required
name
required
string

Required. Cloud account display name

provider
string
Enum: "AWS" "GCP"

Optional. Cloud provider. Default: 'AWS'

accessKeyId
required
string

Required. Cloud provider access key

accessSecretKey
required
string

Required. Cloud provider secret key

consoleUsername
required
string

Required. Cloud provider management console username

consolePassword
required
string

Required. Cloud provider management console password

signInLoginUrl
required
string

Required. Cloud provider management console login URL

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Delete cloud account

Delete specified cloud account

Authorizations:
x-api-keyx-api-secret-key
path Parameters
cloudAccountId
required
integer <int32> >= 0

Cloud Account Id

Responses

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Get cloud account by id

Information on a specific cloud account

Authorizations:
x-api-keyx-api-secret-key
path Parameters
cloudAccountId
required
integer <int32> >= 0

Cloud Account Id

Responses

Response samples

Content type
application/json
{}

Get cloud accounts

List all configured cloud accounts

Authorizations:
x-api-keyx-api-secret-key

Responses

Response samples

Content type
application/json
{
  • "accountId": 40131,
  • "cloudAccounts": [
    • {
      • "id": 1,
      • "name": "Redis Labs Internal Resources",
      • "provider": "AWS",
      • "status": "active",
      • "links": [ ]
      },
    • {
      • "id": 2,
      • "name": "CAPI User ",
      • "provider": "AWS",
      • "status": "active",
      • "accessKeyId": "A***A",
      • "links": [ ]
      },
    • {
      • "id": 3,
      • "name": "API Cloud account",
      • "provider": "AWS",
      • "status": "active",
      • "accessKeyId": "A***4",
      • "links": [ ]
      }
    ],
  • "links": []
}

Update cloud account

Update cloud account

Authorizations:
x-api-keyx-api-secret-key
path Parameters
cloudAccountId
required
integer <int32> >= 0

Cloud Account Id

Request Body schema: application/json
required
name
string

name

accessKeyId
required
string

Required. Cloud provider access key

accessSecretKey
required
string

Required. Cloud provider secret key

consoleUsername
required
string

Required. Cloud provider management console username

consolePassword
required
string

Required. Cloud provider management console password

signInLoginUrl
string

Optional. Cloud provider management console login URL

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Users

Data and operations related to account's users

Delete user

Delete a user from current account

Authorizations:
x-api-keyx-api-secret-key
path Parameters
userId
required
integer <int32>

User Id

Responses

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Get user by id

Information on user identified by user Id

Authorizations:
x-api-keyx-api-secret-key
path Parameters
userId
required
integer <int32>

User Id

Responses

Response samples

Content type
application/json
{
  • "id": 60192,
  • "name": "Clifford O'neill",
  • "email": "clifford.mail@gmail.com",
  • "role": "Viewer",
  • "userType": "Local",
  • "hasApiKey": false,
  • "options": {
    • "billing": false,
    • "emailAlerts": false,
    • "operationalEmails": false,
    • "mfaEnabled": false
    }
}

Get users

Information on current account's users

Authorizations:
x-api-keyx-api-secret-key

Responses

Response samples

Content type
application/json
{
  • "account": 1001,
  • "users": [
    • {
      • "id": 60192,
      • "name": "Clifford O'neill",
      • "email": "clifford.mail@gmail.com",
      • "role": "Viewer",
      • "userType": "Local",
      • "hasApiKey": false,
      • "options": {
        • "billing": false,
        • "emailAlerts": false,
        • "operationalEmails": false,
        • "mfaEnabled": false
        }
      }
    ]
}

Update user

Update an existing user by Id

Authorizations:
x-api-keyx-api-secret-key
path Parameters
userId
required
integer <int32>

User Id

Request Body schema: application/json
required
name
required
string

User name

role
string
Enum: "Owner" "Member" "Viewer" "Logs Viewer (API use only)" "Manager" "Billing Admin"

Role name

Responses

Request samples

Content type
application/json
{
  • "name": "My new user name",
  • "role": "Owner"
}

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Tasks

Displays information on long running operations

Get task by id

Get specific long running operation, identified by Task Id

Authorizations:
x-api-keyx-api-secret-key
path Parameters
taskId
required
string

Task Id

Responses

Response samples

Content type
application/json
{
  • "taskId": "e6e9d88a-9b63-468a-aec3-b7a11de27af8",
  • "commandType": "string",
  • "status": "initialized",
  • "description": "string",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "response": {
    • "resourceId": 0,
    • "additionalResourceId": 0,
    • "resource": { },
    • "error": "UNAUTHORIZED",
    • "additionalInfo": "string"
    },
  • "links": [
    • {
      • "property1": { },
      • "property2": { }
      }
    ]
}

Get tasks

Currently active long running operations

Authorizations:
x-api-keyx-api-secret-key

Responses