Welcome to Idea Armor

Redis

    • Redis Cloud
      Expand all Collapse all
      • Quick start
      • Databases
        • Create database
          • Create Essentials database
          • Create Pro database (new subscription)
          • Create Pro database (existing subscription)
          • Create Active-Active database
        • Edit and view
        • Import data
        • Back up database
        • Migrate databases
        • Tag database
        • Monitor performance
        • Flush data
        • Delete database
        • Configure
          • Active-Active Redis
          • Advanced capabilities
          • Clustering
          • Data eviction
          • Data persistence
          • High availability
      • Subscriptions
        • View and Upgrade Essentials plan
          • Redis Cloud Essentials plans
        • View and edit Pro plan
        • Upgrade from Essentials to Pro
        • Delete subscription
        • Maintenance
          • Set maintenance windows
      • Logs & reports
        • System logs
        • Usage reports
      • Accounts & settings
        • Account settings
        • User account and profile
      • Billing & payments
      • Marketplace integrations
        • AWS Marketplace
          • Amazon Bedrock
            • Set up Redis
            • Create knowledge base
            • Create agent
        • Confluent
        • Google Cloud Marketplace
          • Team management
        • Prometheus and Grafana
        • Pulumi
          • Get started
        • Terraform
          • Get started
      • Security
        • Access control
          • Access management
          • Social login
          • Multi-factor authentication
          • SAML SSO
            • Auth0 integration
            • AWS IAM Identity Center integration
            • Azure AD integration
            • Google workspace integration
            • Okta integration (Generic)
            • Okta integration (Org2Org)
            • PingIdentity integration
          • Data access control
            • Default user
            • Role-based access control
            • Configure ACLs
            • Create roles
            • Create users
            • Active-Active roles
        • Shared responsibility model
        • Cloud database security
          • Transport Layer Security (TLS)
          • Network security
        • CIDR allow list
        • Encryption at rest
        • Private Service Connect
        • Transit Gateway
        • VPC peering
      • REST API
        • Get started
          • Enable the API
          • Manage API keys
          • Use the API
          • Manage tasks
          • API request lifecycle
        • Examples
          • Create and manage subscriptions
          • Create databases
          • Update databases
          • Database backup and import
          • Estimate cost
          • Audit using Service Log
          • View account information
          • Manage cloud accounts
      • Open source compatibility
      • Changelog
        • April 2024
        • March 2024
        • February 2024
        • January 2024
        • December 2023
        • November 2023
        • October 2023
        • September 2023
        • August 2023
        • July 2023
        • June 2023
        • May 2023
        • April 2023
        • March 2023
        • February 2023
        • January 2023
    • Redis Enterprise Software
      Expand all Collapse all
      • Install and upgrade
        • Quickstarts
          • Quickstart
          • Docker quickstart
        • Install
          • Plan deployment
            • Hardware requirements
            • Supported platforms
            • Persistent node storage
            • File locations
            • AWS EC2 configuration
          • Prepare to install
            • Download installation package
            • Ensure port availability
          • Install on Linux
          • Installation script options
          • Manage install questions
          • Customize install locations
          • Customize user and group
          • Offline installation
        • Upgrade
          • Upgrade cluster
          • Upgrade database
          • Active-Active databases
          • Upgrade operating system
        • Uninstall
        • Additional configuration
          • CentOS/RHEL firewall
          • Linux swap configuration
          • Socket file location
        • Product lifecycle
        • Create support package
      • Clusters
        • Set up cluster
        • Add a node
        • Configure
          • Cluster settings
          • License keys
          • Sync node clocks
          • Rack-zone awareness
        • Optimize
          • Benchmark
          • Disk sizing
          • Environment optimization
          • Free system memory
          • Redis OSS Cluster API
          • WAIT command
        • Maintenance mode
        • Recover a cluster
        • Remove node
        • Replace node
        • Logging
          • Log security
          • rsyslog
            • Cluster alerts/events
            • Database alerts/events
            • Node alerts/events
            • User events
          • Slow log
        • Monitoring
          • Prometheus integration
          • Prometheus metrics
          • Uptrace integration
          • Nagios integration
      • Databases
        • Create a database
        • Configure
          • Database defaults
          • Upgrade configuration
          • OSS Cluster API
          • Persistence
          • Proxy policy
          • Replica high availability
          • Shard placement
        • Connect
          • Supported connection clients
          • Test connection
          • Troubleshoot
        • Import and export
          • Import data
          • Export data
          • Flush database
          • Schedule backups
          • Migrate to Active-Active
          • Replica Of
            • Create Replica Of database
            • Troubleshoot repeat failures
        • Recover
        • Delete
        • Active-Active
          • Get started
          • Planning considerations
          • Create
          • Connect
          • Manage
          • Delete
          • Causal consistency
          • Distributed synchronization
          • Syncer process
          • Develop applications
            • Develop for Active-Active
            • Data types
              • Hashes
              • HyperLogLog
              • JSON
              • Lists
              • Sets
              • Sorted sets
              • Streams
              • Strings and bitfields
            • App failover
        • Auto Tiering
          • Quick start
          • Manage storage engine
        • Durability and availability
          • Clustering
          • Consistency
          • Discovery service
          • Replication
        • Memory and performance
          • Eviction policy
          • Memory limits
          • Shard placement policy
      • Networking
        • AWS Route 53 DNS
        • Cluster load balancer setup
        • Configure cluster DNS
        • mDNS client prerequisites
        • Multi-IP and IPv6
        • Network ports
        • Public and private endpoints
      • Security
        • Admin console security
        • Access control
          • Cluster management access
          • Database access
          • Manage users
            • Add users
            • Manage user login and session
            • Manage default user
          • Manage passwords
            • Password complexity rules
            • Password expiration
            • Rotate passwords
            • Update Active-Active admin credentials
          • Role-based access control
            • Configure ACLs
            • Create roles
            • Assign roles to users
          • LDAP authentication
            • Enable role-based LDAP
            • Map LDAP groups to roles
            • Update database ACLs
            • Migrate to role-based LDAP
        • Audit events
        • Certificates
          • Create certificates
          • Monitor certificates
          • Update certificates
          • Enable OCSP stapling
        • Encryption
          • TLS
            • Enable TLS
            • Configure TLS protocol
            • Configure cipher suites
          • Internode encryption
          • Encrypt private keys
      • Reference
        • Supported platforms
        • Redis clients
        • Benchmark Auto Tiering
        • Command-line utilities
          • crdb-cli (manage Active-Active)
            • crdb
              • add-instance
              • create
              • delete
              • flush
              • get
              • health-report
              • list
              • purge-instance
              • remove-instance
              • update
            • task
              • cancel
              • list
              • status
          • redis-cli (run Redis commands)
          • rladmin (manage cluster)
            • bind
            • cluster
              • certificate
              • config
              • create
              • debug_info
              • join
              • master
              • ocsp
              • recover
              • reset_password
              • running_actions
              • stats_archiver
            • failover
            • help
            • info
            • migrate
            • node
              • addr
              • enslave
              • external_addr
              • maintenance_mode
              • recovery_path
              • remove
              • snapshot
            • placement
            • recover
            • restart
            • status
            • suffix
            • tune
            • upgrade
            • verify
          • rlcheck (verify nodes)
        • Metrics
          • Auto Tiering
          • Database operations
          • Resource usage
        • Open source compatibility
          • Commands
            • Cluster management
            • Connection management
            • Data types
            • Keys (generic)
            • Pub/sub
            • Scripting
            • Server management
            • Transactions
          • Configuration settings
          • RESP
        • REST API
          • Quick start
          • Encrypt requests
          • Requests
            • actions
              • bdb
            • bdbs
              • actions
                • backup_reset_status
                • export
                • export_reset_status
                • import
                • import_reset_status
                • optimize_shards_placement
              • alerts
              • crdt_sources/alerts
              • debuginfo
              • modules
                • config
                • upgrade
              • passwords
              • peer_stats
              • replica_sources/alerts
              • stats
                • last
              • sync_source_stats
              • syncer_state
                • crdt
                • replica
              • upgrade
            • bootstrap
              • validate
            • cluster
              • actions
              • alerts
              • auditing/db_conns
              • certificates
                • rotate
              • debuginfo
              • ldap
              • module-capabilities
              • policy
              • services_configuration
              • stats
                • last
              • update_cert
            • crdb_tasks
            • crdbs
              • flush
              • health_report
              • purge
              • updates
            • debuginfo
              • all
                • bdb
              • node
                • bdb
            • endpoints/stats
            • jsonschema
            • ldap_mappings
            • license
            • logs
            • modules
              • config/bdb
              • upgrade/bdb
            • nodes
              • actions
              • alerts
              • debuginfo
              • snapshots
              • stats
                • last
              • status
            • ocsp
              • status
              • test
            • proxies
            • redis_acls
            • roles
            • shards/stats
              • last
            • suffix
            • suffixes
            • users
              • authorize
              • password
              • refresh_jwt
          • Objects
            • action
            • alert
            • bdb
              • backup_location/export_location
              • dataset_import_sources
              • replica_sources status
              • replica_sync
              • snapshot_policy
              • status
              • syncer_sources
            • bdb_group
            • bootstrap
              • cluster_identity
              • credentials
              • identity
              • limits
              • node_identity
              • paths
              • policy
            • check_result
            • cluster
              • alert_settings
              • cluster_alert_settings_with_threshold
            • cluster_settings
            • crdb
              • cluster_info
              • database_config
              • health_report
                • health_report_configuration
              • instance_info
              • modify_request
            • crdb_task
            • db_alerts_settings
              • bdb_alert_settings_with_threshold
            • db_conns_auditing_config
            • job_scheduler
              • backup_job_settings
              • cert_rotation_job_settings
              • log_rotation_job_settings
              • node_checks_job_settings
              • redis_cleanup_job_settings
              • rotate_ccs_job_settings
            • jwt_authorize
            • ldap
            • ldap_mapping
            • module
            • node
            • ocsp
            • ocsp_status
            • proxy
            • redis_acl
            • role
            • services_configuration
              • cm_server
              • crdb_coordinator
              • crdb_worker
              • mdns_server
              • pdns_server
              • stats_archiver
            • shard
              • backup
              • loading
              • sync
            • state-machine
            • statistics
              • cluster metrics
              • DB metrics
              • node metrics
              • shard metrics
            • suffix
            • user
          • Permissions
        • Terminology
      • Release notes
        • 7.4.2 releases
          • 7.4.2-104 (March 2024)
          • 7.4.2-54 (February 2024)
        • 7.2.4 releases
          • 7.2.4-105 (February 2024)
          • 7.2.4-92 (November 2023)
          • 7.2.4-72 (October 2023)
          • 7.2.4-64 (September 2023)
          • 7.2.4-52 (August 2023)
        • 6.4.2 releases
          • 6.4.2-103 (October 2023)
          • 6.4.2-94 (July 2023)
          • 6.4.2-81 (June 2023)
          • 6.4.2-69 (May 2023)
          • 6.4.2-61 (April 2023)
          • 6.4.2-43 (March 2023)
          • 6.4.2-30 (February 2023)
        • 6.2.18 releases
          • 6.2.18-70 (January 2023)
          • 6.2.18-65 (December 2022)
          • 6.2.18-58 (November 2022)
          • 6.2.18-49 (October 2022)
          • 6.2.18-43 (September 2022)
        • 6.2.12 (August 2022)
        • 6.2.10 (February 2022)
        • 6.2.8 (October 2021)
        • 6.2.4 (August 2021)
        • 6.0.20 (April 2021)
        • 6.0.12 (January 2021)
        • 6.0.8 (September 2020)
        • 6.0 (May 2020)
        • Previous releases
          • 5.6.0 (April 2020)
          • 5.5 preview (April 2019)
          • 5.4.14 (February 2020)
          • 5.4.10 (December 2019)
          • 5.4.6 (July 2019)
          • 5.4.4 (June 2019)
          • 5.4.2 (April 2019)
          • 5.4 (December 2018)
          • 5.2.2 (August 2018)
          • 5.3 beta(July 2018)
          • 5.2 (June 2018)
          • 5.0.2 (2018 March)
          • 5.0 (November 2017)
          • 4.5 (May 2017)
          • 4.4 (December 2016)
          • 4.3.0-230 (August 2, 2016)
          • 4.2.1-30 (October 18, 2015)
          • 4.0.0-49 (June 18, 2015)
          • 0.99.5-24 (February 15, 2015)
          • 0.99.5-11 (January 5, 2015)
    • Redis Enterprise for Kubernetes
      Expand all Collapse all
      • Architecture
        • What is an operator?
      • Deployment
        • Kubernetes
        • OpenShift
          • OpenShift CLI
          • OpenShift OperatorHub
        • Deployment options
        • Use a private container registry
      • Upgrade
        • Kubernetes
        • OpenShift CLI
      • Redis Enterprise clusters (REC)
        • Connect to the admin console
        • Auto Tiering
        • Manage multiple namespaces
        • Recover a Redis cluster
        • Export metrics to Prometheus
      • Redis Enterprise databases (REDB)
        • Manage databases
        • Create replica databases
      • Active-Active databases
        • Prepare clusters
        • Create database
        • Edit participating clusters
        • Global configuration
        • Global database secret
        • Edit RERC
        • Create Active-Active with crdb-cli
      • Networking
        • Ingress routing
        • OpenShift routes
        • Istio ingress routing
        • REC external routing
      • Security
        • Manage REC credentials
        • Manage REC certificates
        • Add client certificates
        • Enable LDAP
        • Internode encryption
      • Logs
        • Collect logs
      • Recommendations
        • Manage resources
        • Persistent volumes
        • Sizing and scaling
        • Node selection
        • Pod stability
      • Reference
        • Supported distributions
        • REC options
        • REDB options
      • Delete custom resources
      • Release notes
        • 7.4.2 releases
          • 7.4.2-2 (March 2024)
          • 7.4.2-2 (Feb 2024)
        • 7.2.4 releases
          • 7.2.4-12 (March 2024)
          • 7.2.4-12 (Dec 2023)
          • 7.2.4-7 (Oct 2023)
          • 7.2.4-2 (Aug 2023)
        • 6.4.2 releases
          • 6.4.2-8 (Dec 2023)
          • 6.4.2-8 (July 2023)
          • 6.4.2-6 (June 2023)
          • 6.4.2-5 (April 2023)
          • 6.4.2-4 (March 2023)
        • 6.2.18 releases
          • 6.2.18-41 (Jan 2023)
          • 6.2.18-41 (Dec 2022)
          • 6.2.18-3 (Nov 2022)
        • 6.2.12-1 (Sept 2022)
        • 6.2.10-45 (July 2022)
        • 6.2.10-34 (May 2022)
        • 6.2.10-4 (March 2022)
        • 6.2.8-15 (January 2022)
        • 6.2.8-11 (January 2022)
        • 6.2.8-2 (November 2021)
        • 6.2.4-1 (September 2021)
        • Previous versions
          • 6.0.20-12 (July 2021)
          • 6.0.20-4 (May 2021)
          • 6.0.12-5 (February 2021)
          • 6.0.8-20 (December 2020)
          • 6.0.8-1 (October 2020)
          • 6.0.6-24 (August 2020)
          • 6.0.6-23 (August 2020)
          • 6.0.6-11 (July 2020)
          • 6.0.6-6 (June 2020)
          • 5.4.14-2 (March 2020)
          • 5.4.10-8 (January 2020)
      • FAQs
    • Redis Stack and Redis Enterprise
      Expand all Collapse all
      • Quick start
      • Install and upgrade modules
        • Install on a cluster
        • Enable for a database
        • Upgrade modules
      • Module lifecycle
      • Enterprise feature compatibility
      • Search and query
        • Commands
        • Configuration
        • Search Active-Active databases
        • Upgrade a database
      • JSON
        • Commands
        • Active-Active databases
      • Time series
        • Commands
        • Configuration
      • Probabilistic
        • Commands
        • Configuration
      • Triggers and functions
      • Gears
        • Install
        • Run with Python
          • Quick start
          • Install
          • Recipes
            • Write-behind caching
        • Run with JVM
          • Quick start
          • Install
          • Commands
            • RG.JDUMPSESSIONS
            • RG.JEXECUTE
          • Classes and functions
            • GearsBuilder
              • accumulate
              • accumulateBy
              • asyncFilter
              • asyncForeach
              • asyncMap
              • callNext
              • callNextArray
              • collect
              • configGet
              • count
              • CreateGearsBuilder
              • execute
              • executeArray
              • filter
              • flatMap
              • foreach
              • hashtag
              • localAccumulateBy
              • log
              • map
              • register
              • repartition
              • run
            • GearsFuture
              • setError
              • setResult
            • Readers
              • CommandOverrider
              • CommandReader
              • JavaReader
              • KeysOnlyReader
              • KeysReader
              • ShardsIDReader
              • StreamReader
          • Recipes
            • Caching strategies
        • Register events
      • Deprecated features
        • Graph
          • Quick start
          • Commands
          • Configuration
      • Release notes
        • RediSearch
          • v2.8 (July 2023)
          • v2.6 (November 2022)
          • v2.4 (March 2022)
          • v2.2 (November 2021)
          • v2.0 (September 2020)
          • v1.6 (January 2020)
          • v1.4 (August 2018)
          • v1.2 (June 2018)
          • v1.1 (April 2018)
          • v1.0 (April 2018)
        • RedisJSON
          • v2.6 (July 2023)
          • v2.4 (November 2022)
          • v2.2 (July 2022)
          • v2.0 (November 2021)
          • v1.0 (December 2017)
        • RedisBloom
          • v2.6 (July 2023)
          • v2.4 (November 2022)
          • v2.2 (December 2019)
          • v2.0 (June 2019)
          • v1.1 (February 2019)
          • v1.0 (September 2017)
        • RedisTimeSeries
          • v1.10 (July 2023)
          • v1.8 (November 2022)
          • v1.6 (January 2022)
          • v1.4 (September 2020)
          • v1.2 (January 2020)
          • v1.0 (June 2019)
        • RedisGraph
          • v2.10 (November 2022)
          • v2.8 (February 2022)
          • v2.4 (March 2021)
          • v2.2 (November 2020)
          • v2.0 (January 2020)
          • v1.2 (April 2019)
          • v1.0 (November 2018)
        • RedisGears
          • v1.2 (February 2022)
          • v1.0 (May 2020)
    • Redis Data Integration
      Expand all Collapse all
      • Architecture
      • Quickstart
        • Ingest
        • Write-behind
      • write-behind
        • Write-behind-configuration
      • Installation
        • Install RDI CLI
        • Offline install
        • Running on Kubernetes
        • Configure Debezium Server
        • Deploy Debezium Server
        • Installation topologies
        • Install RedisGears
        • Deploy a Debezium Server VM cluster using Pacemaker
        • Add tables to pipeline
        • Use multiple Debezium connectors
      • Data transformation
        • Data transformation pipeline
        • Data type handling
        • Data denormalization
        • Data transformation examples
          • Multiple Redis targets
          • Write to a Redis hash
          • Write to a Redis JSON document
          • Write to a Redis set
          • Write to a Redis sorted set
          • Write to a Redis stream
          • Write-behind foreach
          • Write-behind to Redis Enterprise target
      • Troubleshooting
      • Upgrading
      • Monitoring
      • Sizing and benchmarking
      • Reference
        • CLI
          • redis-di
          • redis-di add-context
          • redis-di configure
          • redis-di create
          • redis-di delete
          • redis-di delete-all-contexts
          • redis-di delete-context
          • redis-di deploy
          • redis-di describe-job
          • redis-di dump-support-package
          • redis-di get-rejected
          • redis-di list-contexts
          • redis-di list-jobs
          • redis-di monitor
          • redis-di reset
          • redis-di scaffold
          • redis-di set-context
          • redis-di set-secret
          • redis-di start
          • redis-di status
          • redis-di stop
          • redis-di trace
          • redis-di upgrade
        • Data type conversion
        • RDI configuration file
        • Data transformation block types
          • add_field
          • cassandra.write
          • filter
          • key
          • map
          • redis.write
          • relational.write
          • remove_field
          • rename_field
        • JMESPath custom functions
        • Debezium Server configuration
          • cassandra
          • mongodb
          • mysql
          • oracle
          • postgresql
          • sqlserver
    • RedisInsight
      Expand all Collapse all
      • Installation
        • Install the RedisInsight Desktop Client
        • Install RedisInsight on Docker
        • Install RedisInsight on Kubernetes
        • Install RedisInsight on AWS EC2
        • Configure RedisInsight
      • Administration
        • Add database
        • Automatically Discovering Databases
        • Adding Databases Programmatically
        • Adding Databases via GET URL
        • Authenticate database users
        • Proxy
        • Performance Metrics
        • Cluster Management
        • Browser
        • CLI
        • Memory analysis
        • Profiler
        • Slowlog
        • Configuration
        • View Java Serialized Objects in Redis
        • Troubleshooting RedisInsight
      • Release notes
        • v2.44.0 (February 2024)
        • v2.42.0 (January 2024)
        • v2.40.0 (December 2023)
        • v2.38.0 (November 2023)
        • v2.36.0 (October 2023)
        • v2.34.0 (September 2023)
        • v2.32.0 (August 2023)
        • v2.30.0 (July 2023)
        • v2.28.0 (June 2023)
        • v2.26.0 (May 2023)
        • v2.24.0 (Apr 2023)
        • v2.22.1 (Mar 2023)
        • v2.20.0 (Feb 2023)
        • v2.18.0 (Jan 2023)
        • v2.16.0 (Dec 2022)
        • v2.14.0 (Nov 2022)
        • v2.12.0 (Oct 2022)
        • v1.14 (May 2023)
        • v2.10.0 (Sept 2022)
        • v2.8.0 (Aug 2022)
        • v1.13 (Aug 2022)
        • v2.6.0 (July 2022)
        • v2.4.0 (June 2022)
        • v2.2.0 (May 2022)
        • v1.12 (May 2022)
        • v2.0 (Nov 2021)
        • v1.11 (Oct 2021)
        • v1.10 (Mar 2021)
        • v1.9 (Jan 2021)
        • v1.8 (Nov 2020)
        • v1.7 (Sep 2020)
        • v1.6 (June 2020)
        • v1.5 (May 2020)
        • v1.4 (Apr 2020)
        • v1.3 (Mar 2020)
        • v1.2 (Jan 2020)
        • v1.1 (Dec 2019)
        • v1.0 (Nov 2019)
        • RDBTools (2019)
          • v0.9.42 (22 Jul 2019)
          • v0.9.41 (4 Jul 2019)
          • v0.9.40.1 (Jun 2019)
          • v0.9.40 (17 May 2019)
          • v0.9.39 (8 May 2019)
          • v0.9.38 (3 May 2019)
          • v0.9.37 (10 Apr 2019)
          • v0.9.36 (Mar 2019)
          • v0.9.35 (Feb 2019)
          • v0.9.34.2 (11 Feb 2019)
          • v0.9.34.1 (7 Feb 2019)
          • v0.9.34.0 (4 Feb 2019)
          • v0.9.34.0 (23 Jan 2019)
          • v0.9.32 (7 Jan 2019)
      • FAQs
      • Memory Optimization for Redis
    • Glossary
    • Embeds
    IdeaArmour > Redis Cloud > REST API > Examples

      REST API Examples

        Create and manage subscriptions

        This article describes how to create and manage a subscription using `cURL` commands.

        Create and manage databases

        This article describes how to create and manage a database using `cURL` commands.

        Update databases

        How to construct requests that update an existing database.

        Database backup and import

        When you create or update a database, you can specify the backup path. The import API operation lets you import data from various source types and specified locations.

        Estimate cost

        How to evaluate the cost of a specific subscription or database without changing existing resources.

        Audit using Service Log

        Use the service log to track and audit actions performed in the account

        View account information

        Get initial information on account parameters

        Create and manage cloud accounts

        Cloud accounts specify which account to use when creating and modifying infrastructure resources.

      Edit on GitHub
      Updated: September 17, 2024
      Top 
      Previous:The API request lifecycle
      Next: Create and manage subscriptions   
      ×