openapi: 3.0.4
info:
  title: Developer API - Upstash
  description: |-
    This is a documentation to specify Developer API endpoints based on the OpenAPI 3.0 specification.
  contact:
    name: Support Team
    email: support@upstash.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.0.0
externalDocs:
  description: Find out more about Upstash
  url: https://upstash.com/
servers:
  - url: https://api.upstash.com/v2
tags:
  - name: redis
    description: Manage redis databases.
    externalDocs:
      description: Find out more
      url: https://upstash.com/docs/devops/developer-api/introduction
  - name: teams
    description: Manage teams and team members.
    externalDocs:
      description: Find out more
      url: https://upstash.com/docs/devops/developer-api/introduction
  - name: vector
    description: Manage vector indices.
    externalDocs:
      description: Find out more
      url: https://upstash.com/docs/devops/developer-api/introduction
  - name: search
    description: Manage search indices.
    externalDocs:
      description: Find out more
      url: https://upstash.com/docs/devops/developer-api/introduction
  - name: qstash
    description: Manage QStash.
    externalDocs:
      description: Find out more
      url: https://upstash.com/docs/devops/developer-api/introduction
paths:
  /redis/databases:
    get:
      tags:
        - redis
      summary: List Databases
      x-mint:
        href: /devops/developer-api/redis/list_databases
      description: This endpoint list all databases of user.
      operationId: listDatabases
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Database"
      security:
        - basicAuth: []
  /redis/database/{id}:
    get:
      tags:
        - redis
      summary: Get Database
      x-mint:
        href: /devops/developer-api/redis/get_database
      description: This endpoint gets details of a database.
      operationId: getDatabase
      parameters:
        - name: id
          in: path
          description: The ID of the database
          required: true
          schema:
            type: string
        - name: credentials
          in: query
          description: Set to 'hide' to remove credentials from the response.
          schema:
            type: string
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Database"
      security:
        - basicAuth: []
    delete:
      tags:
        - redis
      summary: Delete Database
      x-mint:
        href: /devops/developer-api/redis/delete_database
      description: This endpoint deletes a database.
      operationId: deleteDatabase
      parameters:
        - name: id
          in: path
          description: The ID of the database to be deleted
          required: true
          schema:
            type: string
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                type: string
                example: "OK"
      security:
        - basicAuth: []
  /redis/database:
    post:
      tags:
        - redis
      summary: Create Redis Database
      description: |
        This endpoint creates a new Redis database.

        To create a database manually, you can use the [Upstash Console](https://console.upstash.com/redis).

        For a quick development database, POST to https://upstash.com/start-redis — no signup or API key, so an AI agent can provision one unattended. Expires in 72 hours unless claimed. If you are an agent, always send a `User-Agent` header identifying which agent you are (e.g. `claude-code`, `cursor`, `codex`, `opencode`) on every request you make to this API.
      x-mint:
        href: /devops/developer-api/redis/create_database_global
      operationId: createDatabase
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateDatabaseRequest"
      responses:
        "200":
          description: Database created successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Database"
      security:
        - basicAuth: []
  /redis/rename/{id}:
    post:
      tags:
        - redis
      summary: Rename Database
      description: This endpoint renames a database.
      x-mint:
        href: /devops/developer-api/redis/rename_database
      operationId: renameDatabase
      parameters:
        - name: id
          in: path
          description: The ID of the database to be renamed
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The new name of the database
              required:
                - name
      responses:
        "200":
          description: Database renamed successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Database"
      security:
        - basicAuth: []
  /redis/reset-password/{id}:
    post:
      tags:
        - redis
      summary: Reset Password
      description: This endpoint updates the password of a database.
      x-mint:
        href: /devops/developer-api/redis/reset_password
      operationId: resetPassword
      parameters:
        - name: id
          in: path
          description: The ID of the database to reset password
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Password reset successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Database"
      security:
        - basicAuth: []
  /redis/enable-tls/{id}:
    post:
      tags:
        - redis
      summary: Enable TLS
      description: This endpoint enables tls on a database.
      x-mint:
        href: /devops/developer-api/redis/enable_tls
      operationId: enableTls
      parameters:
        - name: id
          in: path
          description: The ID of the database to enable TLS
          required: true
          schema:
            type: string
      responses:
        "200":
          description: TLS enabled successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Database"
      security:
        - basicAuth: []
  /redis/enable-eviction/{id}:
    post:
      tags:
        - redis
      summary: Enable Eviction
      description: This endpoint enables eviction for given database.
      x-mint:
        href: /devops/developer-api/redis/enable_eviction
      operationId: enableEviction
      parameters:
        - name: id
          in: path
          description: The ID of the database to enable eviction
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Eviction enabled successfully
          content:
            application/json:
              schema:
                type: string
                example: "OK"
      security:
        - basicAuth: []
  /redis/disable-eviction/{id}:
    post:
      tags:
        - redis
      summary: Disable Eviction
      description: This endpoint disables eviction for given database.
      x-mint:
        href: /devops/developer-api/redis/disable_eviction
      operationId: disableEviction
      parameters:
        - name: id
          in: path
          description: The ID of the database to disable eviction
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Eviction disabled successfully
          content:
            application/json:
              schema:
                type: string
                example: "OK"
      security:
        - basicAuth: []
  /redis/enable-autoupgrade/{id}:
    post:
      tags:
        - redis
      summary: Enable Auto Upgrade
      description: This endpoint enables Auto Upgrade for given database.
      x-mint:
        href: /devops/developer-api/redis/enable_autoscaling
      operationId: enableAutoUpgrade
      parameters:
        - name: id
          in: path
          description: The ID of the database to enable auto upgrade
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Auto upgrade enabled successfully
          content:
            application/json:
              schema:
                type: string
                example: "OK"
      security:
        - basicAuth: []
  /redis/disable-autoupgrade/{id}:
    post:
      tags:
        - redis
      summary: Disable Auto Upgrade
      description: This endpoint disables Auto Upgrade for given database.
      x-mint:
        href: /devops/developer-api/redis/disable_autoscaling
      operationId: disableAutoUpgrade
      parameters:
        - name: id
          in: path
          description: The ID of the database to disable auto upgrade
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Auto upgrade disabled successfully
          content:
            application/json:
              schema:
                type: string
                example: "OK"
      security:
        - basicAuth: []
  /redis/{id}/change-plan:
    post:
      tags:
        - redis
      summary: Change Database Plan
      description: This endpoint changes the plan of a Redis database.
      x-mint:
        href: /devops/developer-api/redis/change_plan
      operationId: changePlan
      parameters:
        - name: id
          in: path
          description: The ID of the database whose plan will be changed
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ChangePlanRequest"
      responses:
        "200":
          description: Plan changed successfully
          content:
            application/json:
              schema:
                type: string
                example: "OK"
      security:
        - basicAuth: []
  /redis/update-budget/{id}:
    patch:
      tags:
        - redis
      summary: Update Database Budget
      description: This endpoint updates the monthly budget of a Redis database.
      x-mint:
        href: /devops/developer-api/redis/update_budget
      operationId: updateBudget
      parameters:
        - name: id
          in: path
          description: The ID of the database whose budget will be updated
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                budget:
                  type: integer
                  description: The new monthly budget for the database
              required:
                - budget
      responses:
        "200":
          description: Budget updated successfully
          content:
            application/json:
              schema:
                type: string
                example: "OK"
      security:
        - basicAuth: []
  /redis/update-regions/{id}:
    post:
      tags:
        - redis
      summary: Update Regions
      description: Update the regions of a database
      x-mint:
        href: /devops/developer-api/redis/update_regions
      operationId: updateRegions
      parameters:
        - name: id
          in: path
          description: The ID of your database
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                read_regions:
                  type: array
                  items:
                    type: string
                    enum:
                      - us-east-1
                      - us-east-2
                      - us-west-1
                      - us-west-2
                      - ca-central-1
                      - eu-central-1
                      - eu-west-1
                      - eu-west-2
                      - sa-east-1
                      - ap-south-1
                      - ap-northeast-1
                      - ap-southeast-1
                      - ap-southeast-2
                  description: Array of Read Regions of the Database
                  example: ["us-west-1", "us-west-2"]
              required:
                - read_regions
      responses:
        "200":
          description: Regions updated successfully
          content:
            application/json:
              schema:
                type: string
                example: "OK"
      security:
        - basicAuth: []
  /redis/move-to-team:
    post:
      tags:
        - redis
      summary: Move To Team
      description: This endpoint moves database under a target team
      x-mint:
        href: /devops/developer-api/redis/moveto_team
      operationId: moveToTeam
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                team_id:
                  type: string
                  description: The ID of the target team
                database_id:
                  type: string
                  description: The ID of the database to be moved
              required:
                - team_id
                - database_id
      responses:
        "200":
          description: Database moved successfully
          content:
            application/json:
              schema:
                type: string
                example: "OK"
      security:
        - basicAuth: []
  /redis/stats/{id}:
    get:
      tags:
        - redis
      summary: Get Database Stats
      description: This endpoint gets detailed stats of a database.
      x-mint:
        href: /devops/developer-api/redis/get_database_stats
      operationId: getDatabaseStats
      parameters:
        - name: id
          in: path
          description: The ID of the database
          required: true
          schema:
            type: string
        - name: period
          in: query
          description: >-
            Period the time series cover: 1h, 3h, 12h, 1d, 3d, 7d or 30d. Defaults to 1h. 30d is
            only available for databases on a Pro plan or with the Production Pack.
          required: false
          schema:
            type: string
            default: 1h
      responses:
        "200":
          description: Database stats retrieved successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DatabaseStats"
      security:
        - basicAuth: []
  /redis/traffic/{id}:
    get:
      tags:
        - redis
      summary: Get Database Traffic
      description: >-
        This endpoint reports where a database's traffic comes from over a period. Available for
        databases on a Pro plan or with the Production Pack.
      x-mint:
        href: /devops/developer-api/redis/get_database_traffic
      operationId: getDatabaseTraffic
      parameters:
        - name: id
          in: path
          description: The ID of the database
          required: true
          schema:
            type: string
        - name: period
          in: query
          description: "The period every figure covers: 1h, 3h, 12h, 1d, 3d, 7d or 30d. Defaults to 1d."
          required: false
          schema:
            type: string
            default: 1d
      responses:
        "200":
          description: Database traffic retrieved successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DatabaseTraffic"
      security:
        - basicAuth: []
  /redis/insights/{id}:
    get:
      tags:
        - redis
      summary: Get Database Insights
      description: >-
        This endpoint returns the Insights series of a database: service latency percentiles,
        read, write, engine, replication, lock-wait and Lua latency, expired entries, replication
        lag, throughput, bandwidth and disk size, for the whole database, one replica or every
        region, with each series' latest window compared to the one before it, and how much the
        limit, security and Lua counters grew over the period. Latencies are in milliseconds. Available for databases on a Pro plan or
        with the Production Pack.
      x-mint:
        href: /devops/developer-api/redis/get_database_insights
      operationId: getDatabaseInsights
      parameters:
        - name: id
          in: path
          description: The ID of the database
          required: true
          schema:
            type: string
        - name: period
          in: query
          description: "The period of the series: 1h, 3h, 12h, 1d, 3d, 7d or 30d. Defaults to 3h."
          required: false
          schema:
            type: string
            default: 3h
        - name: replica
          in: query
          description: >-
            Restrict the series to one replica, by the key of a group whose kind is replica.
            Other keys are rejected with 400.
          required: false
          schema:
            type: string
        - name: by
          in: query
          description: Set to region to receive one series per region next to the total.
          required: false
          schema:
            type: string
            enum:
              - region
      responses:
        "200":
          description: Database insights retrieved successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/DatabaseInsights"
      security:
        - basicAuth: []
  /redis/backup-analysis/{id}/{backupid}:
    get:
      tags:
        - redis
      summary: Get Backup Analysis
      description: >-
        This endpoint returns the state of a backup's analysis and, once completed, the report.
        Daily backups of databases on a Pro plan or with the Production Pack are analyzed
        automatically when they complete, except on regional and HIPAA databases and for backups
        over 200 GiB.
      x-mint:
        href: /devops/developer-api/redis/backup/get_backup_analysis
      operationId: getBackupAnalysis
      parameters:
        - name: id
          in: path
          description: The ID of the database
          required: true
          schema:
            type: string
        - name: backupid
          in: path
          description: The ID of the backup
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Analysis state retrieved successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/BackupAnalysis"
      security:
        - basicAuth: []
    post:
      tags:
        - redis
      summary: Analyze Backup
      description: >-
        This endpoint starts the offline analysis of a completed backup. The analysis scans the
        backup without touching the running database and takes minutes for large backups; poll
        the GET endpoint until the state is completed or failed. Available for databases on a Pro
        plan or with the Production Pack; other databases get 404. Not available for RDB exports,
        backups over 200 GiB, HIPAA databases or regional databases, nor for a backup whose
        analysis is already pending or completed.
      x-mint:
        href: /devops/developer-api/redis/backup/analyze_backup
      operationId: analyzeBackup
      parameters:
        - name: id
          in: path
          description: The ID of the database
          required: true
          schema:
            type: string
        - name: backupid
          in: path
          description: The ID of the backup
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Analysis started
          content:
            application/json:
              schema:
                type: object
                properties:
                  analysis_state:
                    type: string
                    example: pending
      security:
        - basicAuth: []
  /redis/list-backup/{id}:
    get:
      tags:
        - redis
      summary: List Backup
      description: This endpoint lists all backups for a Redis database.
      x-mint:
        href: /devops/developer-api/redis/backup/list_backup
      operationId: listBackup
      parameters:
        - name: id
          in: path
          description: The ID of the Redis database
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Backups retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Backup"
      security:
        - basicAuth: []
  /redis/create-backup/{id}:
    post:
      tags:
        - redis
      summary: Create Backup
      description: This endpoint creates a backup for a Redis database.
      x-mint:
        href: /devops/developer-api/redis/backup/create_backup
      operationId: createBackup
      parameters:
        - name: id
          in: path
          description: The ID of the Redis database
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Name of the backup
              required:
                - name
      responses:
        "200":
          description: Backup created successfully
          content:
            application/json:
              schema:
                type: string
                example: "OK"
      security:
        - basicAuth: []
  /redis/delete-backup/{id}/{backup_id}:
    delete:
      tags:
        - redis
      summary: Delete Backup
      description: This endpoint deletes a backup of a Redis database.
      x-mint:
        href: /devops/developer-api/redis/backup/delete_backup
      operationId: deleteBackup
      parameters:
        - name: id
          in: path
          description: The ID of the Redis database
          required: true
          schema:
            type: string
        - name: backup_id
          in: path
          description: The ID of the backup to delete
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Backup deleted successfully
          content:
            application/json:
              schema:
                type: string
                example: "OK"
      security:
        - basicAuth: []
  /redis/restore-backup/{id}:
    post:
      tags:
        - redis
      summary: Restore Backup
      description: This endpoint restores data from an existing backup.
      x-mint:
        href: /devops/developer-api/redis/backup/restore_backup
      operationId: restoreBackup
      parameters:
        - name: id
          in: path
          description: The ID of the Redis database
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                backup_id:
                  type: string
                  description: ID of the backup to restore
              required:
                - backup_id
      responses:
        "200":
          description: Backup restored successfully
          content:
            application/json:
              schema:
                type: string
                example: "OK"
      security:
        - basicAuth: []
  /redis/enable-dailybackup/{id}:
    patch:
      tags:
        - redis
      summary: Enable Daily Backup
      description: This endpoint enables daily backup for a Redis database.
      x-mint:
        href: /devops/developer-api/redis/backup/enable_dailybackup
      operationId: enableDailyBackup
      parameters:
        - name: id
          in: path
          description: The ID of the Redis database
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Daily backup enabled successfully
          content:
            application/json:
              schema:
                type: string
                example: "OK"
      security:
        - basicAuth: []
  /redis/disable-dailybackup/{id}:
    patch:
      tags:
        - redis
      summary: Disable Daily Backup
      description: This endpoint disables daily backup for a Redis database.
      x-mint:
        href: /devops/developer-api/redis/backup/disable_dailybackup
      operationId: disableDailyBackup
      parameters:
        - name: id
          in: path
          description: The ID of the Redis database
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Daily backup disabled successfully
          content:
            application/json:
              schema:
                type: string
                example: "OK"
      security:
        - basicAuth: []
  /teams:
    get:
      tags:
        - teams
      summary: List Teams
      x-mint:
        href: /devops/developer-api/teams/list_teams
      description: This endpoint lists all teams of user.
      operationId: listTeams
      responses:
        "200":
          description: Teams retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/Team"
      security:
        - basicAuth: []
  /auditlogs:
    servers:
    - url: https://api.upstash.com
    get:
      tags:
        - auditlogs
      summary: List Audit Logs
      x-mint:
        href: /devops/developer-api/account/list_audit_logs
      description: This endpoint lists all audit logs of user.
      operationId: listAuditLogs
      responses:
        "200":
          description: Audit logs retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/AuditLog"
      security:
        - basicAuth: []
  /team:
    post:
      tags:
        - teams
      summary: Create Team
      x-mint:
        href: /devops/developer-api/teams/create_team
      description: This endpoint creates a new team.
      operationId: createTeam
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateTeamRequest"
      responses:
        "200":
          description: Team created successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Team"
      security:
        - basicAuth: []
  /team/{id}:
    delete:
      tags:
        - teams
      summary: Delete Team
      x-mint:
        href: /devops/developer-api/teams/delete_team
      description: This endpoint deletes a team.
      operationId: deleteTeam
      parameters:
        - name: id
          in: path
          description: The ID of the team to delete
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Team deleted successfully
          content:
            application/json:
              schema:
                type: string
                example: "OK"
      security:
        - basicAuth: []
  /teams/{team_id}:
    get:
      tags:
        - teams
      summary: Get Team Members
      description: This endpoint list all members of a team.
      x-mint:
        href: /devops/developer-api/teams/get_team_members
      operationId: getTeamMembers
      parameters:
        - name: team_id
          in: path
          description: ID of the team
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Team members retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/TeamMember"
      security:
        - basicAuth: []
  /teams/member:
    post:
      tags:
        - teams
      summary: Add Team Member
      description: This endpoint adds a new team member to the specified team.
      x-mint:
        href: /devops/developer-api/teams/add_team_member
      operationId: addTeamMember
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/AddTeamMemberRequest"
      responses:
        "200":
          description: Team member added successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TeamMember"
      security:
        - basicAuth: []
    delete:
      tags:
        - teams
      summary: Delete Team Member
      description: This endpoint deletes a team member from the specified team.
      x-mint:
        href: /devops/developer-api/teams/delete_team_member
      operationId: deleteTeamMember
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/DeleteTeamMemberRequest"
      responses:
        "200":
          description: Team member deleted successfully
          content:
            application/json:
              schema:
                type: string
                example: "OK"
      security:
        - basicAuth: []
  /vector/index:
    get:
      tags:
        - vector
      summary: List Indices
      description: This endpoint returns the data related to all indices of an account as a list.
      x-mint:
        href: /devops/developer-api/vector/list_indices
      operationId: listIndices
      responses:
        "200":
          description: Indices retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/VectorIndex"
      security:
        - basicAuth: []
    post:
      tags:
        - vector
      summary: Create Index
      description: This endpoint creates an index.
      x-mint:
        href: /devops/developer-api/vector/create_index
      operationId: createIndex
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/CreateIndexRequest"
      responses:
        "200":
          description: Index created successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/VectorIndex"
      security:
        - basicAuth: []
  /vector/index/{id}:
    get:
      tags:
        - vector
      summary: Get Index
      description: This endpoint returns the data associated to a index.
      x-mint:
        href: /devops/developer-api/vector/get_index
      operationId: getIndex
      parameters:
        - name: id
          in: path
          description: The unique ID of the index to fetch
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Index retrieved successfully
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/VectorIndex"
      security:
        - basicAuth: []
    delete:
      tags:
        - vector
      summary: Delete Index
      description: This endpoint deletes an index.
      x-mint:
        href: /devops/developer-api/vector/delete_index
      operationId: deleteIndex
      parameters:
        - name: id
          in: path
          description: The unique ID of the index to be deleted
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Index deleted successfully
          content:
            application/json:
              schema:
                type: string
                example: "OK"
      security:
        - basicAuth: []
  /vector/index/{id}/rename:
    post:
      tags:
        - vector
      summary: Rename Index
      description: This endpoint is used to change the name of an index.
      x-mint:
        href: /devops/developer-api/vector/rename_index
      operationId: renameIndex
      parameters:
        - name: id
          in: path
          description: The unique ID of the index to be renamed
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The new name of the index
              required:
                - name
      responses:
        "200":
          description: Index renamed successfully
          content:
            application/json:
              schema:
                type: string
                example: "OK"
      security:
        - basicAuth: []
  /vector/index/{id}/reset-password:
    post:
      tags:
        - vector
      summary: Reset Index Passwords
      description: This endpoint is used to reset regular and readonly tokens of an index.
      x-mint:
        href: /devops/developer-api/vector/reset_index_passwords
      operationId: resetIndexPasswords
      parameters:
        - name: id
          in: path
          description: The unique ID of the index to reset the password for
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Index passwords reset successfully
          content:
            application/json:
              schema:
                type: string
                example: "OK"
      security:
        - basicAuth: []
  /vector/index/{id}/setplan:
    post:
      tags:
        - vector
      summary: Set Index Plan
      description: This endpoint is used to change the plan of an index.
      x-mint:
        href: /devops/developer-api/vector/set_index_plan
      operationId: setIndexPlan
      parameters:
        - name: id
          in: path
          description: The unique ID of the index to change plan for
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                target_plan:
                  type: string
                  description: The new plan for the index
                  enum:
                    - free
                    - payg
                    - fixed
              required:
                - target_plan
      responses:
        "200":
          description: Index plan changed successfully
          content:
            application/json:
              schema:
                type: string
                example: "OK"
      security:
        - basicAuth: []
  /vector/index/{id}/transfer:
    post:
      tags:
        - vector
      summary: Transfer Index
      description: |
        This endpoint is used to transfer an index to another team. 
        Transferring to a personal account is not supported. However, transferring an index from a personal account to a team is allowed.
      x-mint:
        href: /devops/developer-api/vector/transfer_index
      operationId: transferIndex
      parameters:
        - name: id
          in: path
          description: The unique ID of the index to be transferred
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                target_account:
                  type: string
                  description: The team ID of the target team.
                  example: "99a4c327-31f0-490f-a594-043ade84085a"
              required:
                - target_account
      responses:
        "200":
          description: Index transferred successfully
          content:
            application/json:
              schema:
                type: string
                example: "OK"
      security:
        - basicAuth: []
  /vector/index/stats:
    get:
      summary: Get Vector Stats
      description: Get vector statistics for all the vector indices associated with the authenticated user
      operationId: getGlobalVectorStats
      tags:
        - vector
      responses:
        '200':
          description: Statistics for the vector indices retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalStats'
      security:
        - basicAuth: []
  /vector/index/{id}/stats:
    get:
      summary: Get Index Stats
      description: Retrieves statistics and metrics for a specific vector index
      operationId: getVectorIndexStats
      tags:
        - vector
      parameters:
        - name: id
          in: path
          description: The ID of the vector index
          required: true
          schema:
            type: string
        - name: period
          in: query
          required: false
          schema:
            type: string
            enum:
              - 1h
              - 3h
              - 12h
              - 1d
              - 3d
              - 7d
              - 30d
            default: 1h
          description: |
            Time period for statistics aggregation. Each period returns 60 datapoints 
            with intervals adjusted to the period length. 
            
            Exceptionally for 30 days, it returns 240 datapoints with 3-hour intervals for increased granularity.
          example: 3h
      responses:
        '200':
          description: Statistics for the specified vector index retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VectorStats'
      security:
        - basicAuth: []
  /search:
    get:
      summary: List Search Indexes
      description: Returns a list of all search indices belonging to the authenticated user.
      operationId: listSearchIndexes
      tags:
        - search
      responses:
        '200':
          description: Successfully retrieved list of search indices.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SearchIndex'
      security:
        - basicAuth: []
    post:
      summary: Create Search Index
      description: Creates a new search index with the specified configuration
      operationId: createSearchIndex
      tags:
        - search
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
                - region
                - type
              properties:
                name:
                  type: string
                  description: Name of the search index
                  example: mySearchIndex
                region:
                  type: string
                  enum: [eu-west-1, us-central1]
                  description: Region of the index
                  example: eu-west-1
                type:
                  type: string
                  enum: [free, payg, fixed]
                  description: Index payment type. Currently 'free' and 'payg' are available.
                  example: payg
      responses:
        '200':
          description: Index created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchIndex'
      security:
        - basicAuth: []
  /search/{id}:
    get:
      summary: Get Search Index
      description: Retrieves detailed information about a specific search index
      operationId: getSearchIndex
      tags:
        - search
      parameters:
        - name: id
          in: path
          description: The unique ID of the search index to be retrieved
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successfully retrieved specified search index
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchIndex'
      security:
        - basicAuth: []
    delete:
      summary: Delete Search Index
      description: Permanently deletes a search index and all its data
      operationId: deleteSearchIndex
      tags:
        - search
      parameters:
        - name: id
          in: path
          description: The unique ID of the search index to be deleted
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Search Index Deleted Successfully
          content:
            application/json:
              schema:
                type: string
                example: "OK"
      security:
        - basicAuth: []
  /search/stats:
    get:
      summary: Get Search Stats
      description: Get search statistics for all the search indices associated with the authenticated user
      operationId: getGlobalSearchStats
      tags:
        - search
      responses:
        '200':
          description: Statistics for the search indices retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GlobalStats'
      security:
        - basicAuth: []
  /search/{id}/stats:
    get:
      summary: Get Index Stats
      description: Retrieves statistics and metrics for a specific search index
      operationId: getSearchIndexStats
      tags:
        - search
      parameters:
        - name: id
          in: path
          description: The ID of the search index
          required: true
          schema:
            type: string
        - name: period
          in: query
          required: false
          schema:
            type: string
            enum:
              - 1h
              - 3h
              - 12h
              - 1d
              - 3d
              - 7d
              - 30d
            default: 1h
          description: |
            Time period for statistics aggregation. Each period returns 60 datapoints 
            with intervals adjusted to the period length. 
            
            Exceptionally for 30 days, it returns 240 datapoints with 3-hour intervals for increased granularity.
          example: 3h
      responses:
        '200':
          description: Statistics for the specified search index retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VectorStats'
      security:
        - basicAuth: []
  /search/{id}/reset-password:
    post:
      summary: Reset Password
      description: This endpoint resets the regular and readonly tokens of a search index.
      operationId: resetSearchPassword
      tags:
        - search
      parameters:
        - name: id
          in: path
          description: The ID of the search index
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Search index passwords reset successfully
          content:
            application/json:
              schema:
                type: string
                example: "OK"
      security:
        - basicAuth: []
  /search/{id}/transfer:
    post:
      summary: Transfer Search Index
      description: | 
        Transfers ownership of a search index to another team.
        Transferring to a personal account is not supported.
        However, transferring from a personal account to a team is allowed.
      operationId: transferSearchIndex
      tags:
        - search
      parameters:
        - name: id
          in: path
          description: The ID of the search index
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                target_account:
                  type: string
                  description: The ID of the target team account.
                  example: "99a4c327-31f0-490f-a594-043ade84085a"
              required:
                - target_account
      responses:
        "200":
          description: Search index transferred successfully
          content:
            application/json:
              schema:
                type: string
                example: "OK"
      security:
        - basicAuth: []
  /search/{id}/rename:
    post:
      summary: Rename Search Index
      description: Renames a search index.
      operationId: renameSearchIndex
      tags:
        - search
      parameters:
        - name: id
          in: path
          description: The ID of the search index
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
              properties:
                name:
                  type: string
                  description: New name for the index
                  example: new-index-name
      responses:
        "200":
          description: Search index renamed successfully
          content:
            application/json:
              schema:
                type: string
                example: "OK"
      security:
        - basicAuth: []
  /qstash/users:
    get:
      summary: List QStash Users
      description: Retrieves a list of all QStash users associated with the account, including plan details, limits, and configuration.
      operationId: listQStashUsers
      tags:
        - qstash
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/QStashUser'
      security:
        - basicAuth: []
  /qstash/user/{id}:
    get:
      summary: Get QStash
      description: Retrieves detailed information about the specified QStash user, including plan details, limits, and configuration
      operationId: getQStashUser
      tags:
        - qstash
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: QStash user ID
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QStashUser'
      security:
        - basicAuth: []
  /qstash/rotate-token/{id}:
    post:
      summary: Reset QStash Token
      description: |
        Resets the authentication credentials for the QStash user account.
        This invalidates the old password and token, and generates new ones.
        Returns the updated user information with new credentials.
      operationId: resetQStashToken
      tags:
        - qstash
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: QStash user ID
      responses:
        '200':
          description: Token reset successfully, returns updated user information with new credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QStashUser'
      security:
        - basicAuth: []
  /qstash/set-plan/{id}:
    post:
      summary: Set QStash Plan
      description: |
        Changes the QStash account to a different plan type.
        This operation changes the plan and associated limits for the QStash account.
      operationId: setQStashPlan
      tags:
        - qstash
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: QStash user ID
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - plan_name
              properties:
                plan_name:
                  type: string
                  description: Target plan to upgrade to
                  enum:
                    - paid
                    - qstash_fixed_1m
                    - qstash_fixed_10m
                    - qstash_fixed_100m
                  example: paid
      responses:
        "200":
          description: QStash plan changed successfully
          content:
            application/json:
              schema:
                type: string
                example: "OK"
      security:
        - basicAuth: []
  /qstash/stats/{id}:
    get:
      summary: Get QStash Stats
      description: |
        Retrieves detailed usage statistics for the QStash account including
        daily requests, billing, bandwidth, and workflow metrics over time.
      operationId: getQStashStats
      tags:
        - qstash
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: QStash user ID
        - name: period
          in: query
          required: false
          schema:
            type: string
            enum:
              - 1h
              - 3h
              - 12h
              - 1d
              - 3d
              - 7d
              - 30d
            default: 1h
          description: |
            Time period for statistics aggregation. Each period returns 60 datapoints
            with intervals adjusted to the period length.

            Exceptionally for 30 days, it returns 240 datapoints with 3-hour intervals for increased granularity.
          example: 3h
      responses:
        '200':
          description: Successful response with usage statistics
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QStashStats'
      security:
        - basicAuth: []
  /qstash/ipv4:
    get:
      summary: Get QStash IPv4 Addresses
      description: Returns the list of IPv4 addresses used by QStash for sending requests.
      operationId: getQStashIPv4
      tags:
        - qstash
      responses:
        '200':
          description: List of IPv4 CIDR blocks
          content:
            application/json:
              schema:
                type: array
                items:
                  type: string
                example: ["3.125.136.186/32", "18.198.95.233/32"]
  /qstash/move-to-team:
    post:
      summary: Move QStash to Team
      description: Moves a QStash instance to a different team.
      operationId: moveQStashToTeam
      tags:
        - qstash
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - qstash_id
                - target_team_id
              properties:
                qstash_id:
                  type: string
                  description: ID of the QStash instance to move
                target_team_id:
                  type: string
                  description: ID of the target team
      responses:
        '200':
          description: QStash moved successfully
          content:
            application/json:
              schema:
                type: string
                example: "OK"
      security:
        - basicAuth: []
  /qstash/update-budget/{id}:
    patch:
      summary: Update QStash Budget
      description: Updates the monthly spending budget limit for a QStash instance.
      operationId: updateQStashBudget
      tags:
        - qstash
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: QStash user ID
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - budget
              properties:
                budget:
                  type: integer
                  description: Monthly spending budget limit in dollars. Minimum 20, maximum 10000, or 0 for no limit.
                  minimum: 0
                  maximum: 10000
                  example: 100
      responses:
        '200':
          description: Budget updated successfully
          content:
            application/json:
              schema:
                type: string
                example: "OK"
      security:
        - basicAuth: []
  /qstash/enable-prodpack/{id}:
    post:
      summary: Enable Production Pack
      description: Enables the production pack for a QStash instance.
      operationId: enableQStashProdPack
      tags:
        - qstash
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: QStash user ID
      responses:
        '200':
          description: Production pack enabled successfully
          content:
            application/json:
              schema:
                type: string
                example: "OK"
      security:
        - basicAuth: []
  /qstash/disable-prodpack/{id}:
    post:
      summary: Disable Production Pack
      description: Disables the production pack for a QStash instance.
      operationId: disableQStashProdPack
      tags:
        - qstash
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: QStash user ID
      responses:
        '200':
          description: Production pack disabled successfully
          content:
            application/json:
              schema:
                type: string
                example: "OK"
      security:
        - basicAuth: []
components:
  schemas:
    Database:
      type: object
      properties:
        database_id:
          type: string
          description: ID of the database
          example: 96ad0856-03b1-4ee7-9666-e81abd0349e1
        database_name:
          type: string
          description: Name of the database
          example: MyRedis
        database_type:
          type: string
          description: Pricing model of the database, one of `free`, `Pay as You Go` or `Enterprise`
          example: Pay as You Go
        region:
          type: string
          description: The region where database is hosted
          enum: ["global"]
          example: global
        port:
          type: integer
          description: Database port for clients to connect
          format: int64
          example: 6379
        creation_time:
          type: integer
          description: Creation time of the database as Unix time
          format: int64
          example: 1752649602
        state:
          type: string
          description: State of database
          enum:
            - active
            - suspended
            - passive
          example: active
        endpoint:
          type: string
          description: Endpoint identifier or hostname of the database (may be a slug like "beloved-stallion-58500" or a full host)
          example: beloved-stallion-58500
        rest_token:
          type: string
          description: REST token for the database. Omitted when credential protection is on, when you pass the `credentials=hide` query parameter to Get Database, or when the API key or your team role is read-only.
        read_only_rest_token:
          type: string
          description: Read-only REST token for the database. Omitted when credential protection is on, or when you pass the `credentials=hide` query parameter to Get Database.
        password:
          type: string
          description: Password of the database. Omitted when credential protection is on, when you pass the `credentials=hide` query parameter to Get Database, or when the API key or your team role is read-only.
        tls:
          type: boolean
          description: TLS/SSL is enabled or not
          example: true
        db_daily_bandwidth_limit:
          type: integer
          description: Daily bandwidth limit for the database (in bytes). The response can omit this field.
          format: int64
        db_max_clients:
          type: integer
          description: Max number of concurrent clients can be opened on this database currently
          format: int64
          example: 10000
        db_max_request_size:
          type: integer
          description: Max size of a request that will be accepted by the database currently(in bytes)
          format: int64
          example: 10485760
        db_disk_threshold:
          type: integer
          description: Total disk size limit that can be used for the database currently(in bytes)
          format: int64
          example: 107374182400
        db_max_entry_size:
          type: integer
          description: Max size of an entry that will be accepted by the database currently(in bytes)
          format: int64
          example: 104857600
        db_memory_threshold:
          type: integer
          description: Max size of a memory the database can use(in bytes)
          format: int64
          example: 3221225472
        db_max_commands_per_second:
          type: integer
          description: Max number of commands can be sent to the database per second
          format: int64
          example: 10000
        db_request_limit:
          type: integer
          description: Total number of commands can be sent to the database
          format: int64
          example: 8024278031528736858
        type:
          type: string
          description: Payment plan of the database
          enum: ["free", "payg", "pro", "paid"]
          example: paid
        budget:
          type: integer
          description: Allocated monthly budget for the database
          format: int64
          example: 360
        primary_region:
          type: string
          description: Primary region of the database cluster
          enum:
            - us-east-1
            - us-east-2
            - us-west-1
            - us-west-2
            - ca-central-1
            - eu-central-1
            - eu-west-1
            - eu-west-2
            - sa-east-1
            - ap-south-1
            - ap-northeast-1
            - ap-southeast-1
            - ap-southeast-2
            - af-south-1
            - us-central1
            - us-east4
            - europe-west1
            - asia-northeast1
          example: us-east-1
        primary_members:
          type: array
          items:
            type: string
          description: List of primary regions in the database cluster
          example: ["us-east-1"]
        all_members:
          type: array
          items:
            type: string
          description: List of all regions in the database cluster
          example: ["us-east-1"]
        eviction:
          type: boolean
          description: Entry eviction is enabled
          example: false
        auto_upgrade:
          type: boolean
          description: Automatic upgrade capability is enabled
          example: false
        consistent:
          type: boolean
          description: Strong consistency mode is enabled
          example: false
        modifying_state:
          type: string
          description: Current modifying state of the database
          example: ""
        db_resource_size:
          type: string
          description: Resource allocation tier
          enum: ["S", "M", "L", "XL", "XXL", "3XL"]
          example: L
        db_type:
          type: string
          description: Database storage engine type
          enum: ["bolt", "badger", "pebble"]
          example: pebble
        db_conn_idle_timeout:
          type: integer
          description: Connection idle timeout in nanoseconds
          format: int64
          example: 21600000000000
        db_lua_timeout:
          type: integer
          description: Lua script execution timeout in nanoseconds
          format: int64
          example: 250000000
        db_lua_credits_per_min:
          type: integer
          description: Lua script execution credits per minute
          format: int64
          example: 10000000000
        db_store_max_idle:
          type: integer
          description: Store connection idle timeout in nanoseconds
          format: int64
          example: 900000000000
        db_max_loads_per_sec:
          type: integer
          description: Maximum load operations per second
          format: int64
          example: 1000000
        db_acl_enabled:
          type: string
          description: Access Control List enabled status
          enum: ["true", "false"]
          example: "false"
        db_acl_default_user_status:
          type: string
          description: Default user access status in ACL
          enum: ["true", "false"]
          example: "true"
        db_eviction:
          type: boolean
          description: Database-level eviction policy status
          example: false
        last_plan_upgrade_time:
          type: integer
          format: int64
          description: Unix timestamp of the last plan upgrade
          example: 0
        replicas:
          type: integer
          description: Replica factor of the database
          example: 5
        user_email:
          type: string
          description: Owner identifier of the database (may be email or marketplace-scoped email)
          example: "example@upstash.com"
        daily_backup_enabled:
          type: boolean
          description: Whether daily backup is enabled
          example: false
        read_regions:
          type: array
          items:
            type: string
          description: Array of read regions of the database
          example: ["us-east-2"]
        securityAddons:
          type: object
          description: Security add-ons and their enablement status
          properties:
            ipWhitelisting:
              type: boolean
            vpcPeering:
              type: boolean
            privateLink:
              type: boolean
            tlsMutualAuth:
              type: boolean
            encryptionAtRest:
              type: boolean
          example:
            ipWhitelisting: false
            vpcPeering: false
            privateLink: false
            tlsMutualAuth: false
            encryptionAtRest: false
        prometheus_enabled:
          type: string
          description: Prometheus integration enabled status
          enum: ["true", "false"]
          example: "false"
        prod_pack_enabled:
          type: boolean
          description: Production pack enabled status
          example: false
      xml:
        name: database
    CreateDatabaseRequest:
      type: object
      properties:
        database_name:
          type: string
          description: Name of the database
          example: "myredis"
        platform:
          type: string
          description: Desired cloud platform for the database.
          enum:
            - aws
            - gcp
          example: "aws"
        primary_region:
          type: string
          description: Primary Region of the Global Database
          enum:
            - us-east-1
            - us-east-2
            - us-west-1
            - us-west-2
            - ca-central-1
            - eu-central-1
            - eu-west-1
            - eu-west-2
            - sa-east-1
            - ap-south-1
            - ap-northeast-1
            - ap-southeast-1
            - ap-southeast-2
            - af-south-1
            - us-central1
            - us-east4
            - europe-west1
            - asia-northeast1
          example: "us-east-1"
        read_regions:
          type: array
          items:
            type: string
            enum:
              - us-east-1
              - us-east-2
              - us-west-1
              - us-west-2
              - ca-central-1
              - eu-central-1
              - eu-west-1
              - eu-west-2
              - sa-east-1
              - ap-south-1
              - ap-northeast-1
              - ap-southeast-1
              - ap-southeast-2
          description: Array of Read Regions of the Database
          example: ["us-west-1", "us-west-2"]
        plan:
          type: string
          description: |
            Specifies the fixed plan type for the database.
            If omitted, the database defaults to either the pay-as-you-go or free plan, based on the account type.
          enum:
            - free
            - payg
            - fixed_250mb
            - fixed_1gb
            - fixed_5gb
            - fixed_10gb
            - fixed_50gb
            - fixed_100gb
            - fixed_500gb
          example: "payg"
        budget:
          type: integer
          description: Monthly budget of the database
          example: 360
        eviction:
          type: boolean
          description: Whether to enable eviction for the database
          example: false
        tls:
          type: boolean
          description: Whether to enable TLS for the database
          example: true
      required:
        - database_name
        - platform
        - primary_region

    ChangePlanRequest:
      type: object
      properties:
        database_id:
          type: string
          description: ID of the database
          example: "6gcefvfd-9627-2tz5-4l71-c5679g19d2g4"
        plan_name:
          type: string
          description: The new plan for the database
          enum:
            - free
            - payg
            - fixed_250mb
            - fixed_1gb
            - fixed_5gb
            - fixed_10gb
            - fixed_50gb
            - fixed_100gb
            - fixed_500gb
          example: "fixed_1gb"
        auto_upgrade:
          type: boolean
          description: Whether to enable automatic upgrade for the database
          example: true
        prod_pack_enabled:
          type: boolean
          description: Whether to enable the production pack for the database
          example: false
      required:
        - plan_name
    DatabaseStats:
      type: object
      properties:
        monitor_count:
          $ref: "#/components/schemas/TimeSeriesData"
          description: Monitor count
        daily_net_commands:
          type: integer
          description: Total number of commands executed today
          example: 7
        daily_read_requests:
          type: integer
          description: Total number of read requests executed today
          example: 7
        daily_write_requests:
          type: integer
          description: Total number of write requests executed today
          example: 0
        connection_count:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Connection count over time
          example: [{ "x": "2025-08-31 15:12:52.799480932 +0000 UTC", "y": 0 }]
        keyspace:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Total number of keys in the database over time
          example: [{ "x": "2025-08-31 15:12:52.799480932 +0000 UTC", "y": 0 }]
        throughput:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Throughput on database connections over time
          example: [{ "x": "2025-08-31 15:12:52.799480932 +0000 UTC", "y": 0 }]
        diskusage:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Disk usage over time
          example: [{ "x": "2025-08-31 15:12:52.799480932 +0000 UTC", "y": 0 }]
        latency_p50:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Median (p50) latency over time
          example: [{ "x": "2025-08-31 15:12:52.799480932 +0000 UTC", "y": 0 }]
        latencymean:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Deprecated alias of latency_p50, kept for older clients. Carries the median, not the mean.
          example: [{ "x": "2025-08-31 15:12:52.799480932 +0000 UTC", "y": 0 }]
        latency_99:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: 99th percentile latency over time
          example: [{ "x": "2025-08-31 15:12:52.799480932 +0000 UTC", "y": 0 }]
        read_latency_p50:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Median (p50) read latency over time
          example: [{ "x": "2025-08-31 15:12:52.799480932 +0000 UTC", "y": 0 }]
        read_latency_mean:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Deprecated alias of read_latency_p50, kept for older clients. Carries the median, not the mean.
          example: [{ "x": "2025-08-31 15:12:52.799480932 +0000 UTC", "y": 0 }]
        read_latency_99:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: 99th percentile read latency over time
          example: [{ "x": "2025-08-31 15:12:52.799480932 +0000 UTC", "y": 0 }]
        write_latency_p50:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Median (p50) write latency over time
          example: [{ "x": "2025-08-31 15:12:52.799480932 +0000 UTC", "y": 0 }]
        write_latency_mean:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Deprecated alias of write_latency_p50, kept for older clients. Carries the median, not the mean.
          example: [{ "x": "2025-08-31 15:12:52.799480932 +0000 UTC", "y": 0 }]
        write_latency_99:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: 99th percentile write latency over time
          example: [{ "x": "2025-08-31 15:12:52.799480932 +0000 UTC", "y": 0 }]
        hits:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Cache hits over time
          example: [{ "x": "2025-08-31 15:12:52.799480932 +0000 UTC", "y": 0 }]
        misses:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Cache misses over time
          example: [{ "x": "2025-08-31 15:12:52.799480932 +0000 UTC", "y": 0 }]
        read:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Read requests over time
          example: [{ "x": "2025-08-31 15:12:52.799480932 +0000 UTC", "y": 0 }]
        write:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Write requests over time
          example: [{ "x": "2025-08-31 15:12:52.799480932 +0000 UTC", "y": 0 }]
        dailyrequests:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Daily requests over time
          example:
            [
              { "x": "2025-08-31 15:12:52.799480932 +0000 UTC", "y": 0 },
              { "x": "2025-09-04 15:12:52.76649148 +0000 UTC", "y": 7 },
            ]
        days:
          type: array
          items:
            type: string
          description: Days of the week for measurement
          example: ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday"]
        dailybilling:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Daily billing amounts over time
          example:
            [
              { "x": "2025-08-31 15:12:52.799480932 +0000 UTC", "y": 0 },
              { "x": "2025-09-04 15:12:52.76649148 +0000 UTC", "y": 1.333 },
            ]
        dailybandwidth:
          type: integer
          description: Total daily bandwidth usage in bytes
          example: 50444740913
        bandwidths:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Bandwidth usage over time
          example:
            [
              { "x": "2025-08-31 15:12:52.799480932 +0000 UTC", "y": 0 },
              { "x": "2025-09-04 15:12:52.76649148 +0000 UTC", "y": 7 },
            ]
        total_monthly_bandwidth:
          type: integer
          description: Total bandwidth used in current month (bytes)
          example: 7
        total_monthly_requests:
          type: integer
          description: Total requests in current month
          example: 7
        total_monthly_read_requests:
          type: integer
          description: Total read requests in current month
          example: 7
        total_monthly_write_requests:
          type: integer
          description: Total write requests in current month
          example: 0
        total_monthly_script_requests:
          type: integer
          description: Deprecated, always 0. Use daily_script_commands from the Prometheus integration
          deprecated: true
          example: 0
        queue_optimized:
          type: boolean
          description: Whether queue optimization is enabled for the database
          example: false
        total_monthly_storage:
          type: integer
          description: Total storage used in current month (bytes)
          example: 0
        current_storage:
          type: integer
          description: Current storage used (bytes)
          example: 0
        total_monthly_billing:
          type: number
          format: float
          description: Total cost in current month
          example: 222.33902763855485
        rest_conn_count:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Open REST connections over time
          example: [{ "x": "2025-08-31 15:12:52.799480932 +0000 UTC", "y": 0 }]
        latency_p90:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Overall 90th percentile latency over time, Pro and Production Pack only
          example: [{ "x": "2025-08-31 15:12:52.799480932 +0000 UTC", "y": 0 }]
        command_latency_p50:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Median time the engine spent executing commands, Pro and Production Pack only
          example: [{ "x": "2025-08-31 15:12:52.799480932 +0000 UTC", "y": 0 }]
        command_latency_99:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: 99th percentile time the engine spent executing commands, Pro and Production Pack only
          example: [{ "x": "2025-08-31 15:12:52.799480932 +0000 UTC", "y": 0 }]
        wait_latency_99:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: 99th percentile time commands waited for the execution lock, Pro and Production Pack only
          example: [{ "x": "2025-08-31 15:12:52.799480932 +0000 UTC", "y": 0 }]
        disk_load_latency_99:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: 99th percentile time to load a key from disk, Pro and Production Pack only
          example: [{ "x": "2025-08-31 15:12:52.799480932 +0000 UTC", "y": 0 }]
        disk_loads:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Keys loaded from disk per ten-minute window, Pro and Production Pack only
          example: [{ "x": "2025-08-31 15:12:52.799480932 +0000 UTC", "y": 0 }]
        lua_latency_p50:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Median Lua script latency over time, Pro and Production Pack only
          example: [{ "x": "2025-08-31 15:12:52.799480932 +0000 UTC", "y": 0 }]
        lua_latency_99:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: 99th percentile Lua script latency over time, Pro and Production Pack only
          example: [{ "x": "2025-08-31 15:12:52.799480932 +0000 UTC", "y": 0 }]
        lua_scripts:
          type: array
          description: Most executed Lua scripts since midnight UTC, Pro and Production Pack only
          items:
            $ref: "#/components/schemas/LuaScriptStat"
        lua_script_count:
          type: number
          description: Number of distinct Lua scripts run since midnight UTC, Pro and Production Pack only
        slow_commands:
          type: array
          description: Commands that exceeded the slow threshold today, Pro and Production Pack only
          items:
            $ref: "#/components/schemas/SlowCommandStat"
        acl_user_logins:
          type: array
          description: Logins per ACL user today, Pro and Production Pack only
          items:
            type: object
            properties:
              username:
                type: string
              logins:
                type: number
        command_counts:
          type: array
          description: Command-specific counts over time
          items:
            $ref: "#/components/schemas/CommandCount"
          example:
            [
              {
                "metric_identifier": "EXISTS",
                "data_points":
                  [{ "x": "2025-08-31 15:12:52.799480932 +0000 UTC", "y": 0 }],
              },
            ]
    LuaScriptStat:
      type: object
      properties:
        sha:
          type: string
        script_name:
          type: string
        count:
          type: number
          description: Executions today
        failures:
          type: number
        timeouts:
          type: number
        memory_limits:
          type: number
        command_count:
          type: number
          description: Redis commands the script ran
        avg_duration_ns:
          type: number
        max_duration_ns:
          type: number
        avg_lua_duration_ns:
          type: number
        avg_command_duration_ns:
          type: number
        avg_allocated_bytes:
          type: number
        max_allocated_bytes:
          type: number
    SlowCommandStat:
      type: object
      properties:
        command:
          type: string
          example: "EVALSHA"
        count:
          type: number
          description: Executions today over the slow threshold
        max_ms:
          type: number
          description: Slowest execution today in milliseconds
    ClientNetwork:
      type: object
      properties:
        prefix:
          type: string
          description: Client network masked to /24 for IPv4 or /48 for IPv6
          example: "203.0.113.0/24"
        entry_region:
          type: string
          description: >-
            Region of the Upstash proxies the network's requests came in through. A network
            entering through several regions has one row per region.
          example: "us-east-1"
        provider:
          type: string
          description: aws, gcp, cloudflare, or internet when the address is not in a published range
        region:
          type: string
          description: Provider region, empty for internet
        count:
          type: number
          description: >-
            Sampled observations. The proxies keep an hour of samples; for longer periods the
            hourly figures are added up over time, so compare rows rather than read it as a
            request count
        weight:
          type: number
          description: Estimated observations, an upper bound, added up over time like count
        share:
          type: number
          description: Share of all sampled observations, 0 to 1
        idle_seconds:
          type: number
          description: Seconds since the network was last seen; for periods over 1h, the lowest value over the period
    TelemetryShare:
      type: object
      properties:
        name:
          type: string
          example: "@upstash/redis@1.34.0"
        count:
          type: number
        share:
          type: number
    InsightGroup:
      type: object
      properties:
        key:
          type: string
          description: Key of the group in metrics and comparison for the all and region groups; pass a replica group's key as the replica parameter
        label:
          type: string
        kind:
          type: string
          enum:
            - all
            - region
            - replica
    DatabaseInsights:
      type: object
      properties:
        groups:
          type: array
          description: Every group the database has, regardless of the scope requested
          items:
            $ref: "#/components/schemas/InsightGroup"
        metrics:
          type: object
          description: >-
            Metric name to group key to data points. The all group is always present; region
            groups are added with by=region. Metrics: latency_p50, latency_p90, latency_p99,
            read_latency_99, write_latency_99, command_latency_99, replication_latency_999,
            wait_latency_99, lua_latency_p50, lua_latency_99, expired_entries (per minute),
            replication_lag (entries), throughput, bandwidth (bytes per second) and diskusage.
          additionalProperties:
            type: object
            additionalProperties:
              type: array
              items:
                $ref: "#/components/schemas/InsightPoint"
        comparison_window:
          type: string
          description: >-
            Length of the latest window the comparison averages: the whole period up to three
            hours, the last three hours for longer periods.
          example: "3h"
        comparison:
          type: object
          description: >-
            Metric name to group key to the mean over the latest window and over the equal window
            right before it. previous is absent when that earlier window has no data.
          additionalProperties:
            type: object
            additionalProperties:
              type: object
              properties:
                current:
                  type: number
                previous:
                  type: number
        counters:
          type: object
          description: >-
            Growth of each counter over the period, for the whole database: over_size_requests
            (TCP and REST), over_size_record_accesses, throttled_commands (writes delayed by
            persistence backpressure), undeliverable (requests and connections the proxies could
            not hand to any replica), auth_failures (TCP and REST, including commands sent before
            authenticating and REST requests over the rate limit), keyspace_notifications, connections_opened, bandwidth_ingress,
            bandwidth_egress (bytes), rest_commands, lua_executions, lua_commands (commands run
            inside scripts), lua_failures, lua_timeouts and lua_memory_limits.
          additionalProperties:
            type: object
            properties:
              total:
                type: number
              last_at:
                type: string
                format: date-time
                description: End of the last bucket the counter grew in, absent when it did not grow
              series:
                type: array
                description: Growth inside each bucket of the period
                items:
                  $ref: "#/components/schemas/InsightPoint"
        anomalies:
          type: object
          description: >-
            Metric name to up to three anomalies of its all series, largest first: stretches where
            the value stayed above both the period's median plus three standard deviations,
            estimated as 1.4826 times the median absolute deviation, and 30% over the median. A
            series with fewer than 8 points after its first positive value reports none. The median is raised to a small per-metric floor, so a
            nearly idle series does not report huge changes. An empty stretch at the start of the
            series is ignored, and a stretch longer than a third of the analyzed points is a level
            change, not an anomaly. Every metric is present; diskusage is never checked and always
            has an empty list.
          additionalProperties:
            type: array
            items:
              $ref: "#/components/schemas/InsightAnomaly"
    InsightAnomaly:
      type: object
      properties:
        start:
          type: string
          description: x of the first point above the threshold
        end:
          type: string
          description: x of the last point above the threshold
        peak:
          type: string
          description: x of the highest point
        peak_value:
          type: number
        baseline:
          type: number
          description: Typical level of the period, the median raised to the metric's floor
        change:
          type: number
          description: peak_value / baseline - 1, where 1 means +100%
    InsightPoint:
      type: object
      properties:
        x:
          type: string
          description: Timestamp of the point
        y:
          type: number
    TrafficRoute:
      type: object
      properties:
        proxy_region:
          type: string
          description: Region the requests entered in
        member_region:
          type: string
          description: Region of the replica that served them
        http_requests:
          type: number
        tcp_connections_opened:
          type: number
        tcp_connections:
          type: number
          description: Connections open now; every other figure covers the requested period
        ingress_bytes:
          type: number
          description: Bytes clients sent
        egress_bytes:
          type: number
          description: Bytes clients received
        errors:
          type: number
        cross_region:
          type: boolean
    DatabaseTraffic:
      type: object
      properties:
        period:
          type: string
          description: The period every figure covers
          example: "1d"
        database_region:
          type: string
          description: Primary region of the database, to compare client regions against
        client_network_window:
          type: string
          description: Same as period
          example: "1d"
        client_networks:
          type: array
          items:
            $ref: "#/components/schemas/ClientNetwork"
        client_network_evictions:
          type: number
          description: >-
            Networks the proxies pushed out of their sampling tables. A value comparable to the
            observations means the list is a sample of the traffic rather than a ranking.
        telemetry_window:
          type: string
          description: Same as period
          example: "1d"
        telemetry:
          type: object
          properties:
            sdks:
              type: array
              items:
                $ref: "#/components/schemas/TelemetryShare"
            platforms:
              type: array
              items:
                $ref: "#/components/schemas/TelemetryShare"
            runtimes:
              type: array
              items:
                $ref: "#/components/schemas/TelemetryShare"
            retries:
              type: object
              properties:
                requests:
                  type: number
                retried:
                  type: number
                rate:
                  type: number
        routes_window:
          type: string
          description: Same as period
          example: "1d"
        routes:
          type: array
          items:
            $ref: "#/components/schemas/TrafficRoute"
        entry_regions:
          type: array
          items:
            type: object
            properties:
              region:
                type: string
              share:
                type: number
        cross_region_share:
          type: number
          description: Share of bytes served by a replica in another region than the entry region
        commands:
          type: object
          description: Command counts over the period, absent when the database saw none
          properties:
            rest_commands:
              type: number
              description: Commands received over REST
            script_commands:
              type: number
              description: Commands that Lua scripts ran internally
    BackupAnalysis:
      type: object
      properties:
        analysis_state:
          type: string
          description: Empty when never analyzed, otherwise pending, completed or failed
          example: completed
        report:
          type: object
          description: >-
            The analysis report, present when completed. Contains totals, per-type size and
            element-count distributions, the biggest keys overall and per type, and a TTL profile.
    CommandCount:
      type: object
      properties:
        metric_identifier:
          type: string
          description: Command name or metric identifier
          example: "EXISTS"
        data_points:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Data points for the given command
    TimeSeriesData:
      type: object
      properties:
        x:
          type: string
          description: Timestamp when measurement was taken
          example: "2023-05-22 10:59:23.426 +0000 UTC"
        y:
          type: number
          description: The measured value
          example: 320
      required:
        - x
        - y
    Backup:
      type: object
      properties:
        database_id:
          type: string
          description: ID of the database
          example: "6gcqwafd-9627-4ec2-4g51-b1429h59c8d4"
        customer_id:
          type: string
          description: Customer ID
          example: "example@upstash.com"
        name:
          type: string
          description: Name of the backup
          example: "test"
        backup_id:
          type: string
          description: ID of the backup
          example: "1d62p45b-c567-1239-b23e-449ads33a62e"
        creation_time:
          type: integer
          description: Creation time of the backup as Unix time
          format: int64
          example: 1757000716
        state:
          type: string
          description: State of the backup
          enum:
            - pending
            - completed
            - failed
          example: "pending"
        backup_size:
          type: integer
          description: Size of the backup
          format: int64
          example: 0
        analysis_state:
          type: string
          description: State of the backup's analysis when one was requested, pending, completed or failed
          example: completed
        daily_backup:
          type: string
          description: Daily backup status
          enum:
            - "true"
            - "false"
          example: "false"
        hourly_backup:
          type: string
          description: Hourly backup status
          enum:
            - "true"
            - "false"
          example: "false"
        internal_backup_tag:
          type: string
          description: Internal backup tag
          example: ""
      xml:
        name: backup
    AuditLog:
      type: object
      properties:
        log_id:
          type: string
          description: Unique identifier for the log entry
          example: "ab9744ed-f51c-4z58-a3cj-e3bs756154du"
        customer_id:
          type: string
          description: The ID or email of the customer associated with the log
          example: "example@example.com"
        actor:
          type: string
          description: The user or system that performed the action
          example: "example@example.com"
        timestamp:
          type: integer
          format: int64
          description: Unix timestamp of when the action occurred
          example: 1764587058
        action:
          type: integer
          description: Numeric ID representing the specific action type
          example: 13
        action_string:
          type: string
          description: Human-readable description of the action
          example: "Delete Team"
        source:
          type: string
          description: The source method or client used to perform the action
          example: "API_KEY - system_tests"
        entity:
          type: string
          description: The primary entity affected by the action
          example: "test_team"
        secondary_entity:
          type: string
          description: A secondary entity affected, "" or "NA" if not applicable
          example: "NA"
        third_entity:
          type: string
          description: A tertiary entity affected, "" or "NA" if not applicable
          example: ""
        readable_format:
          type: string
          description: formatted string for display purposes
          example: ""
        ip:
          type: string
          format: ipv4
          description: The IP address from which the request originated
          example: "1.2.3.4"
        ttl:
          type: integer
          format: int64
          description: Time to live (expiration) timestamp for this log entry
          example: 1780311858
        reason:
          type: string
          description: The reason for the action, if provided
          example: ""
        notes:
          type: string
          description: Additional notes regarding the action
          example: ""
      xml:
        name: audit_log
    Team:
      type: object
      properties:
        team_id:
          type: string
          description: ID of the team
          example: "95849b27-40d0-4532-8695-d2028847f823"
        team_name:
          type: string
          description: Name of the team
          example: "test_team_name"
        copy_cc:
          type: boolean
          description: Whether creditcard information added to team during creation or not
          example: true
      xml:
        name: team
    TeamMember:
      type: object
      properties:
        team_id:
          type: string
          description: ID of the team
          example: "3423cb72-e50d-43ec-a9c0-f0f359941223"
        team_name:
          type: string
          description: Name of the team
          example: "test_team_name_2"
        member_email:
          type: string
          description: Email of the team member
          example: "example@upstash.com"
        member_role:
          type: string
          description: Role of the team member
          enum:
            - owner
            - admin
            - dev
            - finance
          example: "dev"
        copy_cc:
          type: boolean
          description: Whether to copy existing credit card information to team member or not
          example: true
      xml:
        name: teamMember
    CreateTeamRequest:
      type: object
      properties:
        team_name:
          type: string
          description: Name of the new team
          example: "myteam"
        copy_cc:
          type: boolean
          description: Whether to copy existing credit card information to team or not
          example: true
      required:
        - team_name
        - copy_cc
    AddTeamMemberRequest:
      type: object
      properties:
        team_id:
          type: string
          description: Id of the team to add the member to
          example: "95849b27-40d0-4532-8695-d2028847f823"
        member_email:
          type: string
          description: Email of the new team member
          example: "example@upstash.com"
        member_role:
          type: string
          description: Role of the new team member
          enum:
            - admin
            - dev
            - finance
          example: "dev"
      required:
        - team_id
        - member_email
        - member_role
    DeleteTeamMemberRequest:
      type: object
      properties:
        team_id:
          type: string
          description: Id of the team to remove the member from
          example: "95849b27-40d0-4532-8695-d2028847f823"
        member_email:
          type: string
          description: Email of the team member to remove
          example: "example@upstash.com"
      required:
        - team_id
        - member_email
    VectorIndex:
      type: object
      properties:
        customer_id:
          type: string
          description: The associated ID of the owner of the index
          example: "example@upstash.com"
        id:
          type: string
          description: Unique ID of the index
          example: "0639864f-ece6-429c-8118-86a287b0e808"
        name:
          type: string
          description: The name of the index
          example: "myindex"
        similarity_function:
          type: string
          description: Similarity function that's used to calculate the distance between two vectors
          enum:
            - COSINE
            - EUCLIDEAN
            - DOT_PRODUCT
          example: "COSINE"
        dimension_count:
          type: number
          description: The amount of values in a single vector
          example: 384
        embedding_model:
          type: string
          description: The predefined embedding model to vectorize your plain text
          enum:
            - BGE_SMALL_EN_V1_5
            - BGE_BASE_EN_V1_5
            - BGE_LARGE_EN_V1_5
            - BGE_M3
          example: "BGE_SMALL_EN_V1_5"
        sparse_embedding_model:
          type: string
          description: The sparse embedding model to be used for indexes
          enum:
            - BM25
            - BGE_M3
          example: "BM25"
        endpoint:
          type: string
          description: The REST endpoint of the index
          example: "glowing-baboon-15797-us1"
        token:
          type: string
          description: The REST authentication token for the index
          example: "QkZGAsWp2tdW0tdC0zNzM1LWV1MkFkNQzB1ExUb3hOekF0TVRJbFpMDNLVSm1GZw=="
        read_only_token:
          type: string
          description: The REST authentication read only token for the index
          example: "QkZGRk1heGSKC0MtdRlZC0zNzM1LWTj3pAV0Wm1aZ01p05qY3RNR0U0TkRtRt2s9azJU"
        type:
          type: string
          description: The payment plan of the index
          enum:
            - free
            - payg
            - fixed
          example: "fixed"
        region:
          type: string
          description: The region where the index is currently deployed
          enum:
            - eu-west-1
            - us-east-1
            - us-central1
          example: "us-east-1"
        max_vector_count:
          type: number
          description: The number of maximum that your index can contain
          example: 5210000
        max_daily_updates:
          type: number
          description: The number of maximum update operations you can perform in a day. Only upsert operations are included in update count.
          example: 1000000
        max_daily_queries:
          type: number
          description: The number of maximum query operations you can perform in a day. Only query operations are included in query count.
          example: 1000000
        max_monthly_bandwidth:
          type: number
          description: The maximum amount of monthly bandwidth for the index. Unit is bytes. -1 if the limit is unlimited.
          example: -1
        max_writes_per_second:
          type: number
          description: The number of maximum write operations you can perform per second. Only upsert operations are included in write count.
          example: 1000
        max_query_per_second:
          type: number
          description: The number of maximum query operations you can perform per second. Only query operations are included in query count.
          example: 1000
        max_reads_per_request:
          type: number
          description: The number of maximum vectors in a read operation. Query and fetch operations are included in read operations.
          example: 1000
        max_writes_per_request:
          type: number
          description: The number of maximum vectors in a write operation. Only upsert operations are included in write operations.
          example: 1000
        max_total_metadata_size:
          type: number
          description: The amount of maximum size for the total metadata sizes in your index.
          example: 53687091200
        reserved_price:
          type: number
          description: Monthly pricing of your index. Only available for fixed and pro plans.
          example: 60
        creation_time:
          type: number
          description: The creation time of the vector index in UTC as unix timestamp.
          example: 1753207106
        index_type:
          type: string
          description: The type of the vector index
          enum:
            - DENSE
            - SPARSE
            - HYBRID
          example: "DENSE"
        throughput_vector:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Throughput data for the vector index over time
          example:
            [
              { "x": "2025-09-04 14:55:00.000 +0000 UTC", "y": 0 },
              { "x": "2025-09-04 14:56:00.000 +0000 UTC", "y": 0 },
            ]
      xml:
        name: vectorIndex
    VectorStats:
      type: object
      properties:
        pending_index_count:
          type: integer
          description: Number of pending index operations
          example: 1
        current_vector_count:
          type: integer
          description: Current number of vectors in the index
          example: 1000
        daily_query_count:
          type: integer
          description: Total number of query operations executed today
          example: 100
        daily_update_count:
          type: integer
          description: Total number of update operations executed today
          example: 10
        monthly_query_count:
          type: integer
          description: Total query operations in current month
          example: 1000
        monthly_update_count:
          type: integer
          description: Total update operations in current month
          example: 1000
        monthly_bandwidth_usage:
          type: integer
          description: Total bandwidth used in current month (bytes)
          example: 7000
        storage_usage:
          type: integer
          description: Current storage used (bytes)
          example: 7000
        monthly_cost:
          type: number
          format: float
          description: Total cost in current month
          example: 0.5
        daily_update_requests:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Daily update requests over time
          example: [{ "x": "2025-10-19 18:33:05.244068975 +0000 UTC", "y": 1 }]
        daily_query_requests:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Daily query requests over time
          example: [{ "x": "2025-10-19 18:33:05.244068975 +0000 UTC", "y": 7 }]
        daily_bandwidths:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Daily bandwidth usage over time
          example: [{ "x": "2025-10-19 18:33:05.244068975 +0000 UTC", "y": 7 }]
        days:
          type: array
          items:
            type: string
          description: Days of the week for measurement
          example: ["Sunday", "Monday", "Tuesday", "Wednesday", "Thursday"]
        query_throughput:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Query throughput over time
          example: [{ "x": "2025-10-23 17:34:00.000 +0000 UTC", "y": 7 }]
        update_throughput:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Update throughput over time
          example: [{ "x": "2025-10-23 17:34:00.000 +0000 UTC", "y": 7 }]
        query_latency_mean:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Average query latency over time
          example: [{ "x": "2025-10-23 17:34:00.000 +0000 UTC", "y": 0 }]
        query_latency_99:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: 99th percentile query latency over time
          example: [{ "x": "2025-10-23 17:34:00.000 +0000 UTC", "y": 0 }]
        update_latency_mean:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Average update latency over time
          example: [{ "x": "2025-10-23 17:34:00.000 +0000 UTC", "y": 0 }]
        update_latency_99:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: 99th percentile update latency over time
          example: [{ "x": "2025-10-23 17:34:00.000 +0000 UTC", "y": 0 }]
        embeds_latency_mean:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Average embedding latency over time
          example: [{ "x": "2025-10-23 17:34:00.000 +0000 UTC", "y": 0 }]
        embeds_latency_99:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: 99th percentile embedding latency over time
          example: [{ "x": "2025-10-23 17:34:00.000 +0000 UTC", "y": 0 }]
        vector_count:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Vector count over time
          example: [{ "x": "2025-10-23 17:35:00.000 +0000 UTC", "y": 2 }]
        data_size:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Data size over time
          example: [{ "x": "2025-10-23 17:35:00.000 +0000 UTC", "y": 76 }]
        daily_rerank_count:
          type: integer
          description: Total number of rerank operations executed today
          example: 0
        monthly_rerank_count:
          type: integer
          description: Total rerank operations in current month
          example: 10
        daily_rerank_requests:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Daily rerank requests over time
          example: [{ "x": "2025-10-19 18:33:05.244068975 +0000 UTC", "y": 1 }]
        rerank_latency_mean:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Average rerank latency over time
          example: [{ "x": "2025-10-23 17:34:00.000 +0000 UTC", "y": 0 }]
        rerank_latency_99:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: 99th percentile rerank latency over time
          example: [{ "x": "2025-10-23 17:34:00.000 +0000 UTC", "y": 0 }]
    SearchIndex:
      type: object
      properties:
        customer_id:
          type: string
          description: The associated ID of the owner of the index
          example: "example@upstash.com"
        id:
          type: string
          format: uuid
          description: Unique ID of the index
          example: 99a4c327-31f0-490f-a594-043ade84085a
        name:
          type: string
          description: Name of the search index
          example: mySearchIndex
        endpoint:
          type: string
          description: The REST endpoint of the index
          example: glowing-baboon-15797-us1
        type:
          type: string
          description: The payment plan of the index
          enum: [free, payg, fixed]
          example: "payg"
        region:
          type: string
          description: The region where the index is currently deployed
          enum: [eu-west-1, us-central1]
          example: us-central1
        vercel_email:
          type: string
          description: The email associated with Vercel integration, if any. Empty string otherwise.
          example: example@vercel.com
        token:
          type: string
          description: The REST authentication token for the index
          example: ZXhhbXBsZUB1cHN0YXNoLmNvbTpuYWJlcg==
        read_only_token:
          type: string
          description: The REST authentication read only token for the search index
          example: ZXhhbXBsZUB1cHN0YXNoLmNvbTpuYWJlcg==
        max_vector_count:
          type: integer
          description: Maximum number of vectors allowed in the index
          example: 2000000
        max_monthly_reranks:
          type: integer
          description: Maximum monthly rerank operations (-1 for unlimited)
          example: -1
        max_daily_updates:
          type: integer
          description: Maximum daily update operations (-1 for unlimited)
          example: -1
        max_daily_queries:
          type: integer
          description: Maximum daily query operations (-1 for unlimited)
          example: -1
        max_monthly_bandwidth:
          type: integer
          description: Maximum monthly bandwidth in bytes (-1 for unlimited)
          example: -1
        max_writes_per_second:
          type: integer
          description: Maximum write operations per second (rate limit)
          example: 1000
        max_query_per_second:
          type: integer
          description: Maximum query operations per second (rate limit)
          example: 1000
        max_reads_per_request:
          type: integer
          description: Maximum number of reads allowed per request
          example: 100
        max_writes_per_request:
          type: integer
          description: Maximum number of writes allowed per request
          example: 100
        creation_time:
          type: integer
          format: int64
          description: Unix timestamp of creation
          example: 1761200000
        input_enrichment_enabled:
          type: boolean
          description: Whether input enrichment is enabled for this index
          example: true
        throughput_vector:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Throughput metrics over time
          example: [{ "x": "2025-10-23 20:54:00.000 +0000 UTC", "y": 0 }]
    GlobalStats:
      type: object
      properties:
        record_count:
          type: integer
          description: Total number of indexed records across all indexes
          example: 10
        request:
          type: integer
          description: Total API requests count across all indexes
          example: 10
        bandwidth:
          type: integer
          description: Total bandwidth usage in bytes across all indexes
          example: 750
        storage:
          type: integer
          description: Total storage usage in bytes across all indexes
          example: 950
        billing:
          type: number
          format: float
          description: Current billing amount across all indexes
          example: 0.001
        rerank_count:
          type: integer
          description: Total reranking operations count across all indexes
          example: 0
    QStashUser:
      type: object
      properties:
        customer_id:
          type: string
          description: Customer identifier (email or team ID)
          example: example@upstash.com
        id:
          type: string
          format: uuid
          description: Unique identifier for the QStash user account
          example: 99a4c327-31f0-490f-a594-043ade84085a
        token:
          type: string
          description: Authentication token for QStash operations
          example: ZXhhbXBsZUB1cHN0YXNoLmNvbTpuYWJlcg==
        read_only_token:
          type: string
          description: Read-only authentication token for QStash operations
          example: ZXhhbXBsZUB1cHN0YXNoLmNvbTpuYWJlcg==
        active:
          type: boolean
          description: Whether the QStash account is active
          example: true
        state:
          type: string
          description: Current state of the QStash account (e.g. `active`, `passive`; other values may be returned)
          example: active
        modifying_state:
          type: string
          description: Transitional state while the console applies an async change (e.g. `suspended` during suspension). Omitted when no change is in progress.
          example: suspended
        last_plan_upgrade_time:
          type: integer
          format: int64
          description: Unix timestamp of the last plan upgrade
          example: 0
        max_message_size:
          type: integer
          description: Maximum message size in bytes
          example: 1048576
        max_requests_per_day:
          type: integer
          description: Soft limit for maximum requests per day
          example: 1000
        max_requests_per_day_hard:
          type: integer
          description: Hard limit for maximum requests per day
          example: 1000
        max_endpoints_per_topic:
          type: integer
          description: Maximum number of endpoints allowed per topic
          example: 100
        max_requests_per_second:
          type: integer
          description: Maximum requests per second (rate limit)
          example: 100
        max_dlq_size:
          type: integer
          description: Maximum dead letter queue size
          example: 1000000
        max_retries:
          type: integer
          description: Maximum number of retry attempts for failed messages
          example: 999
        max_topics:
          type: integer
          description: Maximum number of topics allowed
          example: 1
        max_schedules:
          type: integer
          description: Maximum number of schedules allowed
          example: 10
        max_events_size:
          type: integer
          description: Maximum size for events
          example: 10000
        max_dlq_retention_time_milis:
          type: integer
          format: int64
          description: Maximum retention time for dead letter queue in milliseconds
          example: 259200000
        max_delay:
          type: integer
          description: Maximum delay for scheduled messages in seconds
          example: 604800
        max_parallelism:
          type: integer
          description: Maximum parallel processing per endpoint
          example: 2
        max_global_parallelism:
          type: integer
          description: Maximum global parallel processing across all endpoints
          example: 10
        max_queues:
          type: integer
          description: Maximum number of queues allowed
          example: 10
        max_bandwidth_per_second:
          type: integer
          format: int64
          description: Maximum bandwidth per second in bytes
          example: 1048576
        prod_pack_enabled:
          type: boolean
          description: Whether production pack features are enabled
          example: false
        prometheus_enabled:
          type: string
          description: Whether Prometheus metrics export is enabled (`"true"` / `"false"` string as returned by the API)
          enum: ["true", "false"]
          example: "false"
        timeout:
          type: integer
          description: Request timeout in seconds
          example: 900
        type:
          type: string
          description: Account billing plan category
          enum: [free, paid]
          example: free
        region:
          type: string
          description: Region where the QStash instance is deployed
          enum: [eu-central-1, us-east-1]
          example: eu-central-1
        reserved_type:
          type: string
          description: |
            Fixed-tier or enterprise label when applicable. May be empty/absent for non-fixed plans.
            Known values include `qstash_fixed_1m`, `qstash_fixed_10m`, `qstash_fixed_100m`, `qstash_fixed`.
            Enterprise accounts may use the prefix `enterprise:` followed by an identifier (e.g. `enterprise:acme`).
          example: ""
        reserved_price:
          type: integer
          description: Reserved plan price (may be `0`)
          example: 0
        created_by:
          type: string
          description: Email of the user who created this account
          example: cahidarda@upstash.com
        creation_time:
          type: integer
          format: int64
          description: Unix timestamp of account creation
          example: 1781871358
        deletion_time:
          type: integer
          format: int64
          description: Unix timestamp of account deletion (`0` if not deleted)
          example: 0
        budget:
          type: integer
          description: Monthly spending budget limit in dollars. 0 means no limit.
          example: 0
        enterprise:
          type: object
          description: Present for enterprise accounts
          properties:
            enabled:
              type: boolean
              description: Whether enterprise features are enabled
              example: true
    QStashStats:
      type: object
      properties:
        days:
          type: array
          items:
            type: string
          description: | 
            Array of day names for the measurement period, typically representing all days in the current month.
            This includes both past and future dates within the current month, so the array covers the entire month regardless of the current day.
            Future days are included to align with other daily metrics arrays, allowing for consistent indexing.
          example: ["Wednesday", "Thursday", "Friday", "Saturday", "Sunday", "Monday", "Tuesday"]
        daily_requests:
          type: array
          items:
            type: object
            properties:
              x:
                type: string
                description: Timestamp in UTC format
                example: "2025-10-01 11:33:05.585757103 +0000 UTC"
              y:
                type: number
                description: Total request count for this day
                example: 0
              workflow_message:
                type: integer
                description: Number of workflow messages for this day
                example: 0
              workflow_run:
                type: integer
                description: Number of workflow runs for this day
                example: 0
          description: Daily request metrics including workflow breakdowns
          example: 
            - x: "2025-10-01 11:33:05.585757103 +0000 UTC"
              y: 0
              workflow_message: 0
              workflow_run: 0
        daily_billings:
          type: array
          items:
            $ref: '#/components/schemas/TimeSeriesData'
          description: Daily billing amounts over time
          example:
            - x: "2025-10-01 11:33:05.585757103 +0000 UTC"
              y: 0
        daily_bandwidths:
          type: array
          items:
            $ref: '#/components/schemas/TimeSeriesData'
          description: Daily bandwidth usage over time
          example:
            - x: "2025-10-01 11:33:05.585757103 +0000 UTC"
              y: 0
        daily_used:
          type: array
          items:
            $ref: '#/components/schemas/TimeSeriesData'
          description: |
            Request counts for the requested time period
            If 1h is specified, it shows 60 data points for every 1 minute within the last 1 hour.
          example:
            - x: "2025-10-01 11:33:05.585757103 +0000 UTC"
              y: 0
        daily_used_workflow:
          type: array
          items:
            $ref: '#/components/schemas/TimeSeriesData'
          description: |
            Workflow usage metrics for the requested time period
            If 1h is specified, it shows 60 data points for every 1 minute within the last 1 hour.
          example:
            - x: "2025-10-01 11:33:05.585757103 +0000 UTC"
              y: 0
        daily_qstash_messages:
          type: array
          items:
            $ref: '#/components/schemas/TimeSeriesWithId'
          description: | 
            QStash message counts broken down by metric identifier for the requested time period.
            If 1h is specified, it shows 60 data points for every 1 minute within the last 1 hour.
          example: [
            {
              id: "delivered",
              data_points: [
                { x: "2023-05-22 10:59:23.426 +0000 UTC", y: 320 },
                { x: "2023-05-22 11:00:23.426 +0000 UTC", y: 450 },
              ],
            },
          ]
        daily_workflow_messages:
          type: array
          items:
            $ref: '#/components/schemas/TimeSeriesWithId'
          description: |
            Workflow metrics broken down by metric identifier for the requested time period.
            If 1h is specified, it shows 60 data points for every 1 minute within the last 1 hour.
          example: [
            {
              id: "canceled",
              data_points: [
                { x: "2023-05-22 10:59:23.426 +0000 UTC", y: 320 },
                { x: "2023-05-22 11:00:23.426 +0000 UTC", y: 450 },
              ],
            },
          ]
        dlq_message_count:
          type: integer
          description: Current number of messages in the dead letter queue
          example: 0
        daily_bandwidth_used:
          type: array
          items:
            $ref: '#/components/schemas/TimeSeriesData'
          description: | 
            Bandwidth usage for the requested time period
            If 1h is specified, it shows 60 data points for every 1 minute within the last 1 hour.
          example:
            - x: "2025-10-01 11:33:05.585757103 +0000 UTC"
              y: 0
        total_monthly_billing:
          type: number
          format: float
          description: Total billing amount for the current month
          example: 5.806
    TimeSeriesWithId:
      type: object
      properties:
        id:
          type: string
          description: Identifier for the time series data
          example: "example_id"
        data_points:
          type: array
          items:
            $ref: "#/components/schemas/TimeSeriesData"
          description: Data points for the time series
          example:
            [
              { "x": "2023-05-22 10:59:23.426 +0000 UTC", "y": 320 },
              { "x": "2023-05-22 11:00:23.426 +0000 UTC", "y": 450 },
            ]
    CreateIndexRequest:
      type: object
      properties:
        name:
          type: string
          description: Name of the index
          example: "myindex"
        region:
          type: string
          description: Region of the database
          enum:
            - eu-west-1
            - us-east-1
            - us-central1
          example: "us-east-1"
        similarity_function:
          type: string
          description: Similarity function that's used to calculate the distance between two vectors
          enum:
            - COSINE
            - EUCLIDEAN
            - DOT_PRODUCT
          example: "COSINE"
        dimension_count:
          type: number
          description: The amount of values in a single vector
          example: 1024
        type:
          type: string
          description: The payment plan of your index
          enum:
            - payg
            - fixed
            - paid
          example: "payg"
        embedding_model:
          type: string
          description: The embedding model to use for the index
          enum:
            - BGE_SMALL_EN_V1_5
            - BGE_BASE_EN_V1_5
            - BGE_LARGE_EN_V1_5
            - BGE_M3
          example: "BGE_M3"
        index_type:
          type: string
          description: The type of the vector index
          enum:
            - DENSE
            - SPARSE
            - HYBRID
          example: "HYBRID"
        sparse_embedding_model:
          type: string
          description: The sparse embedding model to be used for indexes
          enum:
            - BM25
            - BGE_M3
          example: "BM25"
      required:
        - name
        - region
        - similarity_function
        - dimension_count
    ApiResponse:
      type: object
      properties:
        code:
          type: integer
          format: int32
        type:
          type: string
        message:
          type: string
      xml:
        name: "##default"
    Error:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
      required:
        - code
        - message
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic