Revyl

Revyl Custom Variables API

The Custom Variables API from Revyl — 7 operation(s) for custom variables.

GitHub OpenAPI

Operations 7

POST /api/v1/variables/custom/add Add Variable Endpoint #
GET /api/v1/variables/custom/check_exists Check Variable Exists Endpoint #
DELETE /api/v1/variables/custom/delete Delete Variable Endpoint #
DELETE /api/v1/variables/custom/delete_all Delete All Variables Endpoint #
GET /api/v1/variables/custom/read_variables Read Variables Endpoint #
PUT /api/v1/variables/custom/update/{variable_id} Update Variable Endpoint #
PUT /api/v1/variables/custom/update_value Update Variable Value Endpoint #

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/revyl/refs/heads/main/openapi/revyl-custom-variables-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/revyl/refs/heads/main/json-schema/revyl-report-context-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/revyl/refs/heads/main/json-schema/revyl-test-resource-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/revyl/refs/heads/main/json-schema/revyl-dashboard-metrics-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/revyl/refs/heads/main/json-schema/revyl-test-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/revyl/refs/heads/main/json-schema/revyl-start-device-info-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/revyl/refs/heads/main/json-schema/revyl-device-session-detail-response-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/revyl:revyl-custom-variables-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

revyl-custom-variables-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: Revyl API
  title: Revyl Custom Variables API
  version: 1.0.0
servers:
- description: Production
  url: https://backend.revyl.ai
tags:
- name: Custom Variables
paths:
  /api/v1/variables/custom/add:
    post:
      description: Add a new variable to the variable table
      operationId: add_variable_endpoint_api_v1_variables_custom_add_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VariableModel'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VariableResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - HTTPBearer: []
      summary: Add Variable Endpoint
      tags:
      - Custom Variables
  /api/v1/variables/custom/check_exists:
    get:
      description: Check if a specific variable exists in the variable table for a given test_uid
      operationId: check_variable_exists_endpoint_api_v1_variables_custom_check_exists_get
      parameters:
      - in: query
        name: test_id
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Test Id
      - in: query
        name: variable_name
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Variable Name
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CheckVariableExistsResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - HTTPBearer: []
      summary: Check Variable Exists Endpoint
      tags:
      - Custom Variables
  /api/v1/variables/custom/delete:
    delete:
      description: Delete a variable for a specific test
      operationId: delete_variable_endpoint_api_v1_variables_custom_delete_delete
      parameters:
      - in: query
        name: test_uid
        required: true
        schema:
          title: Test Uid
          type: string
      - in: query
        name: variable_name
        required: true
        schema:
          title: Variable Name
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VariablesResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - HTTPBearer: []
      summary: Delete Variable Endpoint
      tags:
      - Custom Variables
  /api/v1/variables/custom/delete_all:
    delete:
      description: Delete all variables for a specific test
      operationId: delete_all_variables_endpoint_api_v1_variables_custom_delete_all_delete
      parameters:
      - in: query
        name: test_uid
        required: true
        schema:
          title: Test Uid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VariablesResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - HTTPBearer: []
      summary: Delete All Variables Endpoint
      tags:
      - Custom Variables
  /api/v1/variables/custom/read_variables:
    get:
      description: Retrieve all variables (including their unique IDs) associated with a specific test ID
      operationId: read_variables_endpoint_api_v1_variables_custom_read_variables_get
      parameters:
      - in: query
        name: test_uid
        required: true
        schema:
          title: Test Uid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VariablesResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - HTTPBearer: []
      summary: Read Variables Endpoint
      tags:
      - Custom Variables
  /api/v1/variables/custom/update/{variable_id}:
    put:
      description: 'Apply a partial merge update (name / value / secret) by stable variable ID.


        Mirrors the global-variable update contract: only provided fields change and

        a secret''s plaintext is encrypted at rest and never returned. Secret

        transitions follow the write-only model: promoting a non-secret encrypts the

        existing value in place (no re-entry); demoting a secret requires a fresh

        value, since the old plaintext is never revealed.'
      operationId: update_variable_endpoint_api_v1_variables_custom_update__variable_id__put
      parameters:
      - in: path
        name: variable_id
        required: true
        schema:
          format: uuid
          title: Variable Id
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateVariableModel'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VariableResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - HTTPBearer: []
      summary: Update Variable Endpoint
      tags:
      - Custom Variables
  /api/v1/variables/custom/update_value:
    put:
      description: 'Update a variable''s value by its stable ID.


        Preserves the variable''s secret status: a secret''s new value is re-encrypted

        so plaintext is never written, and the response stays masked.'
      operationId: update_variable_value_endpoint_api_v1_variables_custom_update_value_put
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateVariableValueModel'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VariableResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
      - HTTPBearer: []
      summary: Update Variable Value Endpoint
      tags:
      - Custom Variables
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    CheckVariableExistsResponse:
      description: Response for check variable exists endpoint.
      properties:
        exists:
          description: Whether the variable exists
          title: Exists
          type: boolean
        variable_name:
          anyOf:
          - type: string
          - type: 'null'
          description: Name of the variable
          title: Variable Name
        variable_value:
          anyOf:
          - type: string
          - type: 'null'
          description: Value of the variable
          title: Variable Value
      required:
      - exists
      title: CheckVariableExistsResponse
      type: object
    VariableResponse:
      description: Response model for single variable operations.
      properties:
        message:
          description: Response message
          title: Message
          type: string
        result:
          $ref: '#/components/schemas/VariableRow'
          description: Variable record
      required:
      - message
      - result
      title: VariableResponse
      type: object
    UpdateVariableValueModel:
      properties:
        variable_id:
          format: uuid
          title: Variable Id
          type: string
        variable_value:
          title: Variable Value
          type: string
      required:
      - variable_id
      - variable_value
      title: UpdateVariableValueModel
      type: object
    VariableRow:
      properties:
        has_secret_value:
          default: false
          description: Whether an encrypted value is stored for this variable
          title: Has Secret Value
          type: boolean
        id:
          description: Unique identifier of the variable
          format: uuid
          title: Id
          type: string
        is_secret:
          default: false
          description: Whether the value is encrypted and masked
          title: Is Secret
          type: boolean
        test_uid:
          description: Test UID associated with variable
          format: uuid
          title: Test Uid
          type: string
        variable_name:
          description: Name of the variable
          title: Variable Name
          type: string
        variable_value:
          anyOf:
          - type: string
          - type: 'null'
          description: Value of the variable
          title: Variable Value
      required:
      - id
      - test_uid
      - variable_name
      title: VariableRow
      type: object
    VariablesResponse:
      description: Response model for variable list operations.
      properties:
        message:
          description: Response message
          title: Message
          type: string
        result:
          description: List of variable records
          items:
            $ref: '#/components/schemas/VariableRow'
          title: Result
          type: array
      required:
      - message
      - result
      title: VariablesResponse
      type: object
    VariableModel:
      properties:
        is_secret:
          default: false
          title: Is Secret
          type: boolean
        test_uid:
          format: uuid
          title: Test Uid
          type: string
        variable_name:
          title: Variable Name
          type: string
        variable_value:
          anyOf:
          - type: string
          - type: 'null'
          title: Variable Value
      required:
      - test_uid
      - variable_name
      title: VariableModel
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
      - loc
      - msg
      - type
      title: ValidationError
      type: object
    UpdateVariableModel:
      description: 'Partial-merge update for a local variable (rename / value / secret).


        Mirrors GlobalVariableUpdate: only fields that are set are applied.

        variable_value is treated as "provided" when not None, so the frontend

        omits it to keep an existing secret''s value unchanged.'
      properties:
        is_secret:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Secret
        test_uid:
          format: uuid
          title: Test Uid
          type: string
        variable_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Variable Name
        variable_value:
          anyOf:
          - type: string
          - type: 'null'
          title: Variable Value
      required:
      - test_uid
      title: UpdateVariableModel
      type: object
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http