> ## Documentation index
> Fetch the complete documentation index at: https://upstash.com/docs/llms.txt
> Ask it with GET https://upstash.com/docs/ask?q=<keywords or question>. Short keywords rank best.
> Use these to discover all available pages before exploring further.
> Feature requests: https://upstash.com/docs/common/help/feature-requests.md lists what users asked for and how to vote for a request or add one.
> Page rating: `GET https://upstash.com/docs/feedback?path=/docs/workflow/api-reference/flow-control/pause-flow-control-key&helpful=true` (or `false`) records whether this page helped. An optional `comment` (URL-encoded, at most 500 characters) says what was missing or wrong. It is anonymous and needs no key. Comments hold no code, secrets or personal data.

# Pause Flow Control Key

> Pauses the delivery of messages associated with a specific flow-control key.

`POST /v2/flowControl/{flowControlKey}/pause`

When a flow-control key is paused, messages associated with that key will not be delivered until the key is resumed.

Messages that are already in the waitlist will remain there. New incoming messages will be added directly to the waitlist.

While the key is paused, the current rate period continues to elapse and the existing rate count is preserved for that period.

## OpenAPI

````yaml workflow/openapi.yaml post /v2/flowControl/{flowControlKey}/pause
openapi: 3.1.0
info:
  title: Upstash Workflow REST API
  description: >
    Upstash Workflow is a serverless workflow orchestration service built on top
    of Upstash QStash and Upstash Redis.
  version: 2.0.0
  contact:
    name: Upstash
    url: https://upstash.com
servers:
  - url: https://qstash-{region}.upstash.io
    description: Regional
    variables:
      region:
        default: eu-central-1
        enum:
          - us-east-1
          - eu-central-1
security:
  - bearerAuth: []
  - bearerAuthQuery: []
paths:
  /v2/flowControl/{flowControlKey}/pause:
    post:
      summary: Pause Flow Control Key
      description: Pauses the delivery of messages associated with a specific
        flow-control key.
      x-mint:
        content: >
          When a flow-control key is paused, messages associated with that key
          will not be delivered until the key is resumed.


          Messages that are already in the waitlist will remain there. New
          incoming messages will be added directly to the waitlist.


          While the key is paused, the current rate period continues to elapse
          and the existing rate count is preserved for that period.
      tags:
        - Flow Control
      parameters:
        - name: flowControlKey
          in: path
          required: true
          schema:
            type: string
          description: The flow-control key to pause.
      responses:
        "200":
          description: The flow-control key has been paused.
        "400":
          description: Bad request. Returned when the flow-control key is not provided.
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Error"
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: QStash authentication token
    bearerAuthQuery:
      type: apiKey
      in: query
      name: qstash_token
      description: QStash authentication token passed as a query parameter
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: Error message
````