openapi: 3.2.0
info:
  title: Boomi Data Integration Variables API
  description: '# Boomi Data Integration API documentation


    Welcome to the Boomi Data Integration API Documentation.'
  contact:
    name: Boomi Data Integration Documentation
    url: https://community.boomi.com/s/support
    email: support@boomi.com
  version: 1.0.0
  x-logo:
    url: https://rivery.io/wp-content/uploads/2021/08/logo.png
servers:
- url: https://api.rivery.io
  description: US
- url: https://api.eu-west-1.rivery.io
  description: EU
tags:
- name: Variables
paths:
  /v1/accounts/{account_id}/environments/{environment_id}/variables:
    get:
      tags:
      - Variables
      summary: List Variables
      description: '**Authorization scope:** `variables:list`


        **List variables**


        ---


        ### 📖 Instructions for usage


        `list_variables`


        ```

        List all variables in an environment.

        ```'
      operationId: list_variables
      security:
      - HTTPBearer: []
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          title: Account Id
      - name: environment_id
        in: path
        required: true
        schema:
          type: string
          title: Environment Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VariablesResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-mcp-tool:
      - list_variables
    put:
      tags:
      - Variables
      summary: Add Or Update Variables
      description: '**Authorization scope:** `variables:edit`


        **Add new variable or update existing one for environment**


        ---


        ### 📖 Instructions for usage


        `upsert_variables`


        ```

        Create or update variables in an environment.


        Each item in variables should be: {"name": "VAR_NAME", "value": "some_value"}.


        Returns {"updated": true, "count": N} (the upstream may return an empty body).

        ```'
      operationId: add_or_update_variables
      security:
      - HTTPBearer: []
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          title: Account Id
      - name: environment_id
        in: path
        required: true
        schema:
          type: string
          title: Environment Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddOrPatchVariablesInput'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VariablesResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-mcp-tool:
      - upsert_variables
    delete:
      tags:
      - Variables
      summary: Delete Variable
      description: '**Authorization scope:** `variables:edit`


        **Delete existing variables by environment**'
      operationId: delete_variable
      security:
      - HTTPBearer: []
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          title: Account Id
      - name: environment_id
        in: path
        required: true
        schema:
          type: string
          title: Environment Id
      - name: variable_key
        in: query
        required: true
        schema:
          type: string
          title: Variable Key
      responses:
        '204':
          description: Successful Response
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    AddOrPatchVariablesInput:
      properties:
        variables:
          type: object
          title: Variables
      type: object
      required:
      - variables
      title: AddOrPatchVariablesInput
      description: Variables input
    VariablesResponse:
      properties:
        variables:
          type: object
          title: Variables
      type: object
      required:
      - variables
      title: VariablesResponse
      description: List of variables response
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
externalDocs:
  description: Find out more about Data Integration
  url: https://help.boomi.com/docs/Atomsphere/Data_Integration/Data_Integration_Overview