REredis
Subscriptions - Pro

Create Pro subscription

Changed on

Creates a new Redis Cloud Pro subscription.

post/v1/subscriptions

Request

  • Base URL
    https://api.redislabs.com
  • URL
    https://api.redislabs.com/v1/subscriptions
  • Auth
    API key in header x-api-key and API key in header x-api-secret-key and API key in header x-auth-token

Request body

namestring

Optional. New subscription name.

dryRunboolean

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 and does not create any resources. Default: 'false'

deploymentType'single-region' | 'active-active'

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

paymentMethod'credit-card' | 'marketplace'

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

paymentMethodIdinteger

Optional. A valid payment method ID for this account. Use GET /payment-methods to get a list of all payment methods for your account. This value is optional if ‘paymentMethod’ is ‘marketplace’, but required for all other account types.

memoryStorage'ram' | 'ram-and-flash'

Optional. Memory storage preference: either 'ram' or a combination of 'ram-and-flash' (also known as Auto Tiering). Default: 'ram'

persistentStorageEncryptionType'cloud-provider-managed-key' | 'customer-managed-key'

Optional. Persistent storage encryption secures data at rest for database persistence. By default, disk storage is encrypted by keys managed by the cloud provider. Use 'customer-managed-key' if you want to use self-managed persistent storage encryption keys. Default: 'cloud-provider-managed-key'

redisVersionstring

Optional. Defines the Redis version of the databases created in this specific request. It doesn't determine future databases associated with this subscription. If not set, databases will use the default Redis version. This field is deprecated and will be removed in a future API version - use the database-level redisVersion property instead.

publicEndpointAccessboolean

Optional. When 'false', all databases on this subscription will reject any connection attempt to the public endpoint and any connection attempt to the private endpoint that does not come from an IP address in the private address space defined in RFC 1918. You must use a private connectivity method to connect to a database with a blocked public endpoint. Default: 'true'.

commandTypestring

Example request

{
  "name": "My new subscription",
  "deploymentType": "single-region",
  "memoryStorage": "ram",
  "persistentStorageEncryptionType": "cloud-provider-managed-key",
  "persistentStorageEncryptionKeys": {
    "customerManagedKeys": [
      {
        "resourceName": "projects/PROJECT_ID/locations/LOCATION/keyRings/KEY_RING/cryptoKeys/KEY_NAME"
      }
    ],
    "deletionGracePeriod": "alerts-only"
  },
  "cloudProviders": [
    {
      "provider": "AWS",
      "cloudAccountId": 1,
      "regions": [
        {
          "region": "us-east-1",
          "networking": {
            "deploymentCIDR": "10.0.0.0/24",
            "vpcId": "<vpc-identifier>"
          }
        }
      ]
    }
  ],
  "databases": [
    {
      "name": "Redis-database-example",
      "port": 10000,
      "memoryLimitInGb": 1,
      "datasetSizeInGb": 1,
      "throughputMeasurement": {
        "value": 10000
      },
      "localThroughputMeasurement": [
        {
          "writeOperationsPerSecond": 1000,
          "readOperationsPerSecond": 1000
        }
      ],
      "modules": [
        {
          "parameters": {}
        }
      ],
      "quantity": 1,
      "ramPercentage": 20,
      "respVersion": "resp3",
      "redisVersion": "7.2",
      "queryPerformanceFactor": "2x"
    }
  ],
  "redisVersion": "7.2"
}

Response

Accepted

taskIdstring uuid
commandTypestring
status'initialized' | 'received' | 'processing-in-progress' | 'processing-completed' | 'processing-error'
descriptionstring
timestampstring date-time
linksobject[]

Changes

  • 6b256e1bb946Revision changes
    • warning

      added the new AGENT_MEMORY_IS_DISABLED enum value to the / response property for the response status

    • warning

      added the new AGENT_MEMORY_STORE_DEPENDENCY_FAILED enum value to the / response property for the response status

    • warning

      added the new AGENT_MEMORY_STORE_FORBIDDEN enum value to the / response property for the response status

    • warning

      added the new AGENT_MEMORY_STORE_INVALID_REQUEST enum value to the / response property for the response status

    • warning

      added the new AGENT_MEMORY_STORE_NOT_FOUND enum value to the / response property for the response status

  • c09dc0db14e1Revision changes
    • warning

      added the new DATABASE_IN_ACTIVE_ENDPOINTS_REDIRECTION enum value to the / response property for the response status

    • warning

      added the new DATABASE_TRAFFIC_NOT_STOPPED enum value to the / response property for the response status

    • warning

      added the new DATABASE_TRAFFIC_RESUME_IN_PROGRESS enum value to the / response property for the response status

    • warning

      added the new DATABASE_TRAFFIC_RESUME_NOT_ELIGIBLE enum value to the / response property for the response status

    • warning

      added the new DATABASE_TRAFFIC_STATE_NOT_FOUND enum value to the / response property for the response status

    • warning

      added the new DB_ENDPOINTS_SERVICE_NOT_FOUND enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_ACCOUNT_MISMATCH enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_ALREADY_EXISTS enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_CONNECTIVITY_MISMATCH enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_DATABASES_NOT_COMPATIBLE enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_DATABASE_STATE_NOT_SUPPORTED enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_DNS_SERVICE_NOT_AVAILABLE enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_INVALID_ENDPOINT_TYPE enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_NOT_COMPLETED enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_NOT_FOUND enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_NOT_LATEST enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_REVERT_WINDOW_EXCEEDED enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_SOURCE_HAS_NO_ENDPOINTS enum value to the / response property for the response status

    • warning

      added the new ENDPOINTS_REDIRECTION_TARGET_HAS_NO_ENDPOINTS enum value to the / response property for the response status

    • warning

      added the new FIXED_DATABASE_MEMCACHED_PROTOCOL_IS_NOT_SUPPORTED_FOR_FREE_PLAN enum value to the / response property for the response status