Requestly API

openapi: 3.1.0
info:
  title: Requestly API
  version: '2026-10-21'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-21: 28 operation(s) read from 23 public documentation page(s) (each
    operation names its page in x-source). This is not the provider''s published contract; Requestly has published no machine-readable contract
    that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 14
    documentation: 14
    pages-with-code: 19
    pages-read: 23
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-21'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.requestly.com/api-client/rq-api-reference/rq-vault.md
  - https://docs.requestly.com/api-client/cli.md
  - https://docs.requestly.com/api-client/import-export/import-from-curl.md
  - https://docs.requestly.com/api-client/mock-server/create-from-openapi.md
  - https://docs.requestly.com/api-client/send-api-request/create-requests/generate-client-code.md
  - https://docs.requestly.com/api-client/mock-server.md
  - https://docs.requestly.com/api-client/run-on-cicd.md
  - https://docs.requestly.com/api-client/mock-server/rules.md
  - https://docs.requestly.com/api-client/mock-server/routes.md
  - https://docs.requestly.com/api-client/mock-server/responses.md
  - https://docs.requestly.com/api-client/verify-linux-download.md
  - https://docs.requestly.com/api-client/mock-server/private-mocks.md
  - https://docs.requestly.com/api-client/collection-runner-data-file.md
  - https://docs.requestly.com/api-client/import-export/import-from-bruno.md
  - https://docs.requestly.com/api-client/mock-server/create-from-collection.md
  - https://docs.requestly.com/api-client/verify-linux-download
  - https://docs.requestly.com/api-client/mock-server
  - https://docs.requestly.com/api-client/mock-server/routes
  - https://docs.requestly.com/api-client/mock-server/responses
  - https://docs.requestly.com/api-client/mock-server/rules
  - https://docs.requestly.com/api-client/send-api-request/create-requests/generate-client-code
  - https://docs.requestly.com/api-client/collection-runner-data-file
  - https://docs.requestly.com/api-client/import-export/import-from-curl
servers:
- url: https://assets.requestly.com
paths:
  /:
    delete:
      operationId: delete
      tags:
      - Api
      summary: DELETE /
      x-source: https://docs.requestly.com/api-client/mock-server/routes.md
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X DELETE https://<id>.mocks.requestly.cloud/static/a/b/c

          ```'
    get:
      operationId: get
      tags:
      - Api
      summary: GET /
      x-source: https://docs.requestly.com/api-client/mock-server/create-from-openapi.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl https://<id>.mocks.requestly.cloud/pets

          ```'
    post:
      operationId: post
      tags:
      - Api
      summary: POST /
      x-source: https://docs.requestly.com/api-client/mock-server/rules.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -X POST -H "Content-Type: application/json"  -d ''{"user":{"role":"admin"}}'' https://<id>.mocks.requestly.cloud/orders

          ```'
  /account:
    get:
      operationId: get_account
      tags:
      - Account
      summary: Responses and selection modes
      x-source: https://docs.requestly.com/api-client/mock-server/responses.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /accounts/{id}:
    get:
      operationId: get_accounts_id
      tags:
      - Accounts
      summary: GET /accounts/:id serves a special response only when id equals 42
      x-source: https://docs.requestly.com/api-client/mock-server/rules.md
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /and:
    get:
      operationId: get_and
      tags:
      - And
      summary: GET /and requires both ?a=1 and ?b=2
      x-source: https://docs.requestly.com/api-client/mock-server/rules.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /assets/desktop/releases/${VERSION}/${APPIMAGE}.sig:
    get:
      operationId: get_assets_desktop_releases_VERSION_APPIMAGE_sig
      tags:
      - Assets
      summary: GET /assets/desktop/releases/${VERSION}/${APPIMAGE}.sig
      x-source: https://docs.requestly.com/api-client/verify-linux-download.md
      parameters:
      - name: VERSION
        in: path
        required: true
        schema:
          type: string
      - name: APPIMAGE
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -fsSLO "https://assets.requestly.com/assets/desktop/releases/${VERSION}/${APPIMAGE}.sig"

          ```'
  /binary-linux-x64-$(RQ_CLI_VERSION:
    get:
      operationId: get_binary_linux_x64_RQ_CLI_VERSION
      tags:
      - Binary Linux X64 Rq Cli Version
      summary: GET /binary-linux-x64-$(RQ_CLI_VERSION
      x-source: https://docs.requestly.com/api-client/run-on-cicd.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -fsSL --retry 5 -O https://sdk-assets.browserstack.com/binary-linux-x64-$(RQ_CLI_VERSION).zip\n      unzip -q binary-linux-x64-$(RQ_CLI_VERSION).zip\n\
          \      mv binary-linuxstatic-x64 browserstack-binary\n      chmod +x browserstack-binary\n      ./browserstack-binary requestly --version\n\
          \    displayName: Install Requestly CLI"
  /binary-linux-x64-$(RQ_CLI_VERSION).zip:
    get:
      operationId: get_binary_linux_x64_RQ_CLI_VERSION_zip
      tags:
      - Binary Linux X64 Rq Cli Version
      summary: Run on CI/CD
      x-source: https://docs.requestly.com/api-client/run-on-cicd.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /binary-linux-x64-$RQ_CLI_VERSION.zip:
    get:
      operationId: get_binary_linux_x64_RQ_CLI_VERSION_zip
      tags:
      - Binary Linux X64 Rq Cli Version
      summary: GET /binary-linux-x64-$RQ_CLI_VERSION.zip
      x-source: https://docs.requestly.com/api-client/run-on-cicd.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -fsSL --retry 5 -O https://sdk-assets.browserstack.com/binary-linux-x64-$RQ_CLI_VERSION.zip\n          unzip -q binary-linux-x64-$RQ_CLI_VERSION.zip\n\
          \          mv binary-linuxstatic-x64 browserstack-binary\n          chmod +x browserstack-binary\n          ./browserstack-binary requestly\
          \ --version"
  /fallback:
    get:
      operationId: get_fallback
      tags:
      - Fallback
      summary: Responses and selection modes
      x-source: https://docs.requestly.com/api-client/mock-server/responses.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /headers:
    get:
      operationId: get_headers
      tags:
      - Headers
      summary: Responses and selection modes
      x-source: https://docs.requestly.com/api-client/mock-server/responses.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /hello:
    get:
      operationId: get_hello
      tags:
      - Hello
      summary: 'Quickstart: your first mock in 60 seconds'
      x-source: https://docs.requestly.com/api-client/mock-server.md
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetHelloResponse'
      x-evidence:
        kind: documentation
  /login:
    post:
      operationId: post_login
      tags:
      - Login
      summary: POST /login
      x-source: https://docs.requestly.com/api-client/import-export/import-from-curl.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostLoginRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl --request POST  --url https://api.example.com/login  --user "myuser:mypassword"  --header "Content-Type: application/json"  --data
          ''{"remember_me": true}''

          ```'
  /or:
    get:
      operationId: get_or
      tags:
      - Or
      summary: GET /or matches when either ?a=1 or ?b=2
      x-source: https://docs.requestly.com/api-client/mock-server/rules.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /orders:
    post:
      operationId: post_orders
      tags:
      - Orders
      summary: POST /orders response is gated on $.user.role existing
      x-source: https://docs.requestly.com/api-client/mock-server/rules.md
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /random:
    get:
      operationId: get_random
      tags:
      - Random
      summary: Responses and selection modes
      x-source: https://docs.requestly.com/api-client/mock-server/responses.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /requestly/7UnZh8QEzMbNTATk/images/mock-server-token-reveal.light.png:
    get:
      operationId: get_requestly_7UnZh8QEzMbNTATk_images_mock_server_token_reveal_light_png
      tags:
      - Requestly
      summary: GET /requestly/7UnZh8QEzMbNTATk/images/mock-server-token-reveal.light.png
      x-source: https://docs.requestly.com/api-client/mock-server/private-mocks.md
      parameters:
      - name: fit
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: curl command callers must send](https://mintcdn.com/requestly/7UnZh8QEzMbNTATk/images/mock-server-token-reveal.light.png?fit=max\&auto=format\&n=7UnZh8QEzMbNTATk\&q=85\&s=ab58dd42f69446b77326ca6b695635d5)
  /requestly/Aax5kHsGNwEBPk2a/images/import-bruno-picker.light.png:
    get:
      operationId: get_requestly_Aax5kHsGNwEBPk2a_images_import_bruno_picker_light_png
      tags:
      - Requestly
      summary: GET /requestly/Aax5kHsGNwEBPk2a/images/import-bruno-picker.light.png
      x-source: https://docs.requestly.com/api-client/import-export/import-from-bruno.md
      parameters:
      - name: fit
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: curl, gRPCurl, OpenAPI, WSDL, HAR and SoapUI.](https://mintcdn.com/requestly/Aax5kHsGNwEBPk2a/images/import-bruno-picker.light.png?fit=max\&auto=format\&n=Aax5kHsGNwEBPk2a\&q=85\&s=63780eb2273ff6545451b343c0675227)
  /secure:
    get:
      operationId: get_secure
      tags:
      - Secure
      summary: GET /secure returns 403 when Authorization header missing
      x-source: https://docs.requestly.com/api-client/mock-server/rules.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /shadow:
    get:
      operationId: get_shadow
      tags:
      - Shadow
      summary: first route wins
      x-source: https://docs.requestly.com/api-client/mock-server/routes.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /slow:
    get:
      operationId: get_slow
      tags:
      - Slow
      summary: Responses and selection modes
      x-source: https://docs.requestly.com/api-client/mock-server/responses.md
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /token:
    get:
      operationId: get_token
      tags:
      - Token
      summary: GET /token
      x-source: https://docs.requestly.com/api-client/rq-api-reference/rq-vault.md
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTokenResponse'
      x-evidence:
        kind: code-example
        language: javascript
        snippet: fetch("https://auth.example.com/token", { /* ... */ })
  /users:
    get:
      operationId: get_users
      tags:
      - Users
      summary: GET /users
      x-source: https://docs.requestly.com/api-client/import-export/import-from-curl.md
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl "https://api.example.com/users?page=2"  --header "Authorization: Bearer YOUR_TOKEN"  --header "Accept: application/json"

          ```'
    post:
      operationId: post_users
      tags:
      - Users
      summary: POST /users
      x-source: https://docs.requestly.com/api-client/import-export/import-from-curl.md
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostUsersRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl --request POST  --url https://api.example.com/users  --header "Authorization: Bearer YOUR_TOKEN"  --header "Content-Type:
          application/json"  --data ''{"name":"Jane Doe","email":"jane@example.com"}''

          ```'
  /users/{id}:
    get:
      operationId: get_users_id
      tags:
      - Users
      summary: serves the captured id straight back to the caller
      x-source: https://docs.requestly.com/api-client/mock-server/routes.md
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /users/{userid}:
    delete:
      operationId: delete_users_userid
      tags:
      - Users
      summary: DELETE /users/{userId}
      x-source: https://docs.requestly.com/api-client/import-export/import-from-curl.md
      parameters:
      - name: userid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl --request DELETE  --url https://api.example.com/users/42  --header "Authorization: Bearer YOUR_TOKEN"

          ```'
    put:
      operationId: put_users_userid
      tags:
      - Users
      summary: PUT /users/{userId}
      x-source: https://docs.requestly.com/api-client/import-export/import-from-curl.md
      parameters:
      - name: userid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutUsersUseridRequest'
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl --request PUT  --url https://api.example.com/users/42  --header "Authorization: Bearer YOUR_TOKEN"  --header "Content-Type:
          application/json"  --data ''{"name":"Jane Smith"}''

          ```'
components:
  schemas:
    DeleteResponse:
      type: object
      properties:
        served:
          type: string
    PostRequest:
      type: object
      properties:
        user:
          type: object
          properties:
            role:
              type: string
    GetHelloResponse:
      type: object
      properties:
        message:
          type: string
          description: Hello, World!
    PostLoginRequest:
      type: object
      properties:
        remember_me:
          type: boolean
    GetTokenResponse:
      type: object
      properties:
        username:
          type: string
    PostUsersRequest:
      type: object
      properties:
        name:
          type: string
        email:
          type: string
    PutUsersUseridRequest:
      type: object
      properties:
        name:
          type: string
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
security:
- bearer: []
tags:
- name: Account
- name: Accounts
- name: And
- name: Api
- name: Assets
- name: Binary Linux X64 Rq Cli Version
- name: Fallback
- name: Headers
- name: Hello
- name: Login
- name: Or
- name: Orders
- name: Random
- name: Requestly
- name: Secure
- name: Shadow
- name: Slow
- name: Token
- name: Users