Rivery Environments API

openapi: 3.2.0
info:
  title: Boomi Data Integration Environments 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: Environments
  description: Listing account's environments
paths:
  /v1/accounts/{account_id}/environments:
    get:
      tags:
      - Environments
      summary: List Environments
      description: '**Authorization scope:** `environment:list`


        **Get list of environments entities for an account**


        ---


        ### 📖 Instructions for usage


        `list_environments`


        ```

        List all environments for an account.

        ```'
      operationId: list_environments
      security:
      - HTTPBearer: []
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          title: Account Id
      - name: include_deleted
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Include Deleted
      - name: is_deployable_environments
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Is Deployable Environments
      - name: items_per_page
        in: query
        required: false
        schema:
          type: integer
          maximum: 500
          minimum: 1
          description: The number of items per page in the paginated list.
          default: 20
          title: Items Per Page
        description: The number of items per page in the paginated list.
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: The current page number in the paginated list.
          default: 1
          title: Page
        description: The current page number in the paginated list.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEnvironmentsPaginationResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      x-mcp-tool:
      - list_environments
    post:
      tags:
      - Environments
      summary: Add Environment
      description: '**Authorization scope:** `environment:edit`


        **Creates a new environment entity**'
      operationId: add_environment
      security:
      - HTTPBearer: []
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          type: string
          title: Account Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnvironmentInput'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentsFields'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/accounts/{account_id}/environments/{environment_id}:
    get:
      tags:
      - Environments
      summary: Get Environment
      description: '**Authorization scope:** `environment:list`


        **Get a specific environment**'
      operationId: get_environment
      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/EnvironmentsFields'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    put:
      tags:
      - Environments
      summary: Patch Environment
      description: '**Authorization scope:** `environment:edit`


        **Updates an existing environment entity**'
      operationId: patch_environment
      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/PatchEnvironmentInput'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvironmentsFields'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - Environments
      summary: Delete Environment
      description: '**Authorization scope:** `environment:delete`


        **Delete Environment**'
      operationId: delete_environment
      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/OperationResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    PatchEnvironmentInput:
      properties:
        environment_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Environment Name
          description: The environment name
          examples:
          - Dev Environment
        color:
          anyOf:
          - $ref: '#/components/schemas/EnvironmentsColorEnum'
          - type: 'null'
          description: The environment color as shown in the app
          examples:
          - Gray.400
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          description: The environment description
          examples:
          - Development environment for new rivers
        is_default:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Default
          description: A flag that indicates whether the environment is the account's default environment
          examples:
          - true
      type: object
      title: PatchEnvironmentInput
      description: Patch Environment Model
    EnvironmentInput:
      properties:
        name:
          type: string
          title: Name
          description: The environment name
          examples:
          - Dev Environment
        color:
          allOf:
          - $ref: '#/components/schemas/EnvironmentsColorEnum'
          description: The environment color as shown in the app
          default: gray.400
          examples:
          - Gray.400
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          description: The environment description
          examples:
          - Development environment for new rivers
        is_default:
          type: boolean
          title: Is Default
          description: A flag that indicates whether the environment is the account's default environment
          default: false
          examples:
          - true
      type: object
      required:
      - name
      title: EnvironmentInput
      description: Add Environment Model
    EnvironmentsColorEnum:
      type: string
      enum:
      - gray.400
      - tagGreen
      - cBlues
      - tagCyan
      - tagGeekBlue
      - cPurples
      - tagPurple
      - tagMagenta
      - cOranges
      - tagOrange
      - yellow.200
      title: EnvironmentsColorEnum
      description: The EnvironmentsColor enum provides all color options for environments
    EnvironmentsFields:
      properties:
        _id:
          type: string
          title: ' Id'
          description: The environment id
          examples:
          - 633ede20f1fc5500111fd7b3
        account:
          type: string
          title: Account
          description: The account id of the user
          examples:
          - 62e7f4352c13160013dc39be
        user_created:
          anyOf:
          - type: string
          - type: 'null'
          title: User Created
          description: The user id of the user who first created the environment
          examples:
          - 62e7f4352c13160013dc39be
        created_at:
          anyOf:
          - type: string
            format: date-time
          - type: string
          - type: 'null'
          title: Created At
          description: The environment creation date time in UTC timezone. Time format YYYY-MM-DDThh:mm:ss.ms
          examples:
          - '2022-07-25T18:38:55.640Z'
        cross_id:
          type: string
          title: Cross Id
          description: The cross id of the environment
          examples:
          - 62e7f4352c13160013dc39be
        updated_at:
          anyOf:
          - type: string
            format: date-time
          - type: string
          - type: 'null'
          title: Updated At
          description: The time in which the environment was last updated (UTC time zone)
          examples:
          - '2022-08-02T13:38:44.054000'
        environment_name:
          type: string
          title: Environment Name
          description: The environment name
          examples:
          - Dev Environment
        color:
          allOf:
          - $ref: '#/components/schemas/EnvironmentsColorEnum'
          description: The environment color as shown in the app
          default: gray.400
          examples:
          - Gray
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          description: The environment description
          examples:
          - Development environment for new rivers
        variables:
          type: object
          title: Variables
          description: Environment's variables
          examples:
          - aws_file_zone: Rivery-rivery
            azure_file_zone: Rivery-rivery
            days_ago: '0'
            gcs_file_zone: Rivery-rivery
            hours_offset: '0'
        is_deleted:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Deleted
          description: A flag that indicates whether the environment is deleted
          default: false
          examples:
          - false
        deleted_by:
          anyOf:
          - type: string
          - type: 'null'
          title: Deleted By
          description: The user id of the user who deleted the environment (if the environment is deleted)
          examples:
          - 62e7f4352c13160013dc39be
        deleted_at:
          anyOf:
          - type: string
            format: date-time
          - type: string
          - type: 'null'
          title: Deleted At
          description: The time in which the environment was deleted (if the environment is deleted). Time format YYYY-MM-DDThh:mm:ss.ms
          examples:
          - '2022-07-25T18:38:55.640Z'
        is_default:
          type: boolean
          title: Is Default
          description: A flag that indicates whether the environment is the account's default environment
          default: false
          examples:
          - true
        updated_by:
          anyOf:
          - type: string
          - type: 'null'
          title: Updated By
          description: The user id of the user who last updated the environment
          examples:
          - 62e7f4352c13160013dc39be
        is_delete_lock:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Delete Lock
          description: A flag that indicates the environment deletion progress
          examples:
          - true
      type: object
      required:
      - _id
      - account
      - cross_id
      - environment_name
      - variables
      title: EnvironmentsFields
      description: "Environments properties to return.\n    "
    ListEnvironmentsPaginationResponse:
      properties:
        next_page:
          anyOf:
          - type: string
          - type: 'null'
          title: Next Page
          description: The next page URL
        previous_page:
          anyOf:
          - type: string
          - type: 'null'
          title: Previous Page
          description: The previous page URL
        page:
          type: integer
          title: Page
          description: The page number
          default: 1
        current_page_size:
          type: integer
          title: Current Page Size
          description: The current page size
        total_items:
          type: integer
          title: Total Items
          description: The total number of entities fetched
          default: 0
        account_id:
          type: string
          title: Account Id
          description: The account id
        items:
          items:
            $ref: '#/components/schemas/EnvironmentsFields'
          type: array
          title: Items
      type: object
      required:
      - current_page_size
      - account_id
      - items
      title: ListEnvironmentsPaginationResponse
      description: The list environments response to return as a paginated list
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    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
    PullRequestStatus:
      type: string
      enum:
      - W
      - E
      - R
      - D
      title: PullRequestStatus
      description: The status of the pull request that we use in the back, and expose in the API
    OperationResponse:
      properties:
        operation_id:
          type: string
          title: Operation Id
          description: The ID of the operation
          examples:
          - 62e7f4352c13160013dc39be
        operation_type:
          type: string
          title: Operation Type
          description: The type of the operation
          examples:
          - dataframe
        run_id:
          type: string
          title: Run Id
          description: The run id of the operation
          examples:
          - 5cbc6bbbc90a4658b00c70a3bb0f3b31
        last_update_date:
          type: string
          format: date-time
          title: Last Update Date
          description: The date time in UTC timezone of the last update
          examples:
          - '2022-08-02T13:38:44.054000'
        status:
          allOf:
          - $ref: '#/components/schemas/PullRequestStatus'
          description: The current status of the operation id
          examples:
          - D
        result:
          anyOf:
          - {}
          - type: 'null'
          title: Result
          description: The result of the operation
          examples:
          - 'true'
        error_message:
          anyOf:
          - type: string
          - type: 'null'
          title: Error Message
          description: The error message of the operation
          examples:
          - '[RVR-QBK-003]: Response value error: Missing Rows/Columns'
      type: object
      required:
      - operation_id
      - operation_type
      - run_id
      - last_update_date
      - status
      title: OperationResponse
      description: Operation properties to return.
  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