H2O.ai

H2O.ai Configurations API

The Configurations API from H2O.ai — 12 operation(s) for configurations.

GitHub OpenAPI

Operations 12

GET /roles/{role_id}/configurations Gets configurations for a given role #
PUT /roles/{role_id}/configurations/{key_name} Sets configuration item for a given role #
DELETE /roles/{role_id}/configurations/{key_names} Deletes role configuration items #
GET /configurations Gets global configurations #
POST /configurations/fetch-url Fetch HTML content from a URL #
PUT /configurations/{key_name} Sets global configuration item #
DELETE /configurations/{key_names} Deletes global configuration items #
GET /users/current/configurations Gets configurations for current users #
GET /users/{user_id}/configurations Gets user configurations #
PUT /users/{user_id}/configurations/{key_name} Sets user configuration item #
POST /users/{user_id}/configurations/{key_name}/reset Resets user configuration item #
DELETE /users/{user_id}/configurations/{key_names} Deletes user configuration items #

Documentation

📖
Documentation
https://docs.h2o.ai/enterprise-h2ogpte/
📖
APIReference
https://h2ogpte.genai.h2o.ai/swagger-ui/
📖
GettingStarted
https://docs.h2o.ai/enterprise-h2ogpte/get-started
📖
Authentication
https://docs.h2o.ai/enterprise-h2ogpte/guide/apis
📖
Documentation
https://docs.h2o.ai/mlops/
📖
APIReference
https://docs.h2o.ai/mlops/model-scoring/mlops-scoring-rest-api

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/h2o-ai/refs/heads/main/openapi/h2o-ai-configurations-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/h2o-ai/refs/heads/main/json-schema/h2o-ai-global-configuration-item-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/h2o-ai/refs/heads/main/json-schema/h2o-ai-user-configuration-item-schema.json

Other Resources

🔗
ChangeLog
https://docs.h2o.ai/enterprise-h2ogpte/changelog

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/h2o-ai:h2o-ai-configurations-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

h2o-ai-configurations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: h2oGPTe REST Configurations API
  description: '# Overview


    Users can easily interact with the h2oGPTe API through its REST API, allowing HTTP requests from any programming language.'
  version: v1.0.0
servers:
- url: https://h2ogpte.genai.h2o.ai/api/v1
security:
- bearerAuth: []
tags:
- name: Configurations
paths:
  /roles/{role_id}/configurations:
    get:
      operationId: list_role_configurations
      summary: Gets configurations for a given role
      description: Gets configurations for a given role.
      tags:
      - Configurations
      parameters:
      - name: role_id
        in: path
        description: The unique identifier of an role.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserConfigurationItem'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        default:
          $ref: '#/components/responses/Unexpected'
  /roles/{role_id}/configurations/{key_name}:
    put:
      operationId: set_role_configuration
      summary: Sets configuration item for a given role
      description: Sets configuration item for a given role.
      tags:
      - Configurations
      parameters:
      - name: role_id
        in: path
        description: The unique identifier of an role.
        required: true
        schema:
          type: string
      - name: key_name
        in: path
        description: The key of the configuration item that will be set.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserConfigurationItem'
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserConfigurationItem'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        default:
          $ref: '#/components/responses/Unexpected'
  /roles/{role_id}/configurations/{key_names}:
    delete:
      operationId: delete_role_configurations
      summary: Deletes role configuration items
      description: Deletes role configuration items for a given role.
      tags:
      - Configurations
      parameters:
      - name: role_id
        in: path
        description: The unique identifier of the role.
        required: true
        schema:
          type: string
      - name: key_names
        in: path
        description: Keys of the configuration items that will be deleted.
        required: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserConfigurationItem'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
        default:
          $ref: '#/components/responses/Unexpected'
  /configurations:
    get:
      operationId: list_global_configurations
      summary: Gets global configurations
      description: Gets global configurations.
      tags:
      - Configurations
      parameters:
      - name: as_admin
        in: query
        description: If set, lists global configurations with admin permissions. The user must be admin.
        required: false
        schema:
          default: false
          type: boolean
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GlobalConfigurationItem'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        default:
          $ref: '#/components/responses/Unexpected'
  /configurations/fetch-url:
    post:
      operationId: fetch_configuration_url
      summary: Fetch HTML content from a URL
      description: Fetches HTML content from a remote URL for use as an email template. Validates that content is HTML and under 100KB. Admin only.
      tags:
      - Configurations
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - url
              properties:
                url:
                  type: string
                  description: The URL to fetch HTML content from.
      responses:
        '200':
          description: HTML content fetched successfully.
          content:
            application/json:
              schema:
                type: object
                properties:
                  content:
                    type: string
                    description: The fetched HTML content.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '502':
          description: Failed to fetch content from the URL.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointError'
        default:
          $ref: '#/components/responses/Unexpected'
  /configurations/{key_name}:
    put:
      operationId: set_global_configuration
      summary: Sets global configuration item
      description: Sets global configuration item (to be used by admins only).
      tags:
      - Configurations
      parameters:
      - name: key_name
        in: path
        description: The key of the configuration item that will be set.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              required:
              - string_value
              - can_overwrite
              - is_public
              type: object
              properties:
                string_value:
                  description: The value to be set for the global config.
                  type: string
                can_overwrite:
                  description: Whether user settings can override this global setting.
                  type: boolean
                is_public:
                  description: Whether users can see the value for this global setting.
                  type: boolean
                value_type:
                  description: The type of the value to be set for the global config.
                  type: string
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GlobalConfigurationItem'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        default:
          $ref: '#/components/responses/Unexpected'
  /configurations/{key_names}:
    delete:
      operationId: delete_global_configurations
      summary: Deletes global configuration items
      description: Deletes global configuration items (to be used by admins only).
      tags:
      - Configurations
      parameters:
      - name: key_names
        in: path
        description: Keys of the configuration items that will be deleted.
        required: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/GlobalConfigurationItem'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        default:
          $ref: '#/components/responses/Unexpected'
  /users/current/configurations:
    get:
      operationId: list_current_user_configurations
      summary: Gets configurations for current users
      description: Gets configurations for current users.
      tags:
      - Configurations
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserConfigurationItem'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        default:
          $ref: '#/components/responses/Unexpected'
  /users/{user_id}/configurations:
    get:
      operationId: list_user_configurations
      summary: Gets user configurations
      description: Gets user configurations (to be used by admins only).
      tags:
      - Configurations
      parameters:
      - name: user_id
        in: path
        description: The unique identifier of the user.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserConfigurationItem'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        default:
          $ref: '#/components/responses/Unexpected'
  /users/{user_id}/configurations/{key_name}:
    put:
      operationId: set_user_configuration
      summary: Sets user configuration item
      description: Sets user configuration item (to be used by admins only).
      tags:
      - Configurations
      parameters:
      - name: user_id
        in: path
        description: The unique identifier of the user.
        required: true
        schema:
          type: string
      - name: key_name
        in: path
        description: The key of the configuration item that will be set.
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              required:
              - string_value
              type: object
              properties:
                string_value:
                  type: string
                value_type:
                  type: string
        required: true
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserConfigurationItem'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        default:
          $ref: '#/components/responses/Unexpected'
  /users/{user_id}/configurations/{key_name}/reset:
    post:
      operationId: reset_user_configuration
      summary: Resets user configuration item
      description: Resets user configuration item (to be used by admins only).
      tags:
      - Configurations
      parameters:
      - name: user_id
        in: path
        description: The unique identifier of the user.
        required: true
        schema:
          type: string
      - name: key_name
        in: path
        description: The key of the configuration item that will be set.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserConfigurationItem'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        default:
          $ref: '#/components/responses/Unexpected'
  /users/{user_id}/configurations/{key_names}:
    delete:
      operationId: delete_user_configurations
      summary: Deletes user configuration items
      description: Deletes user configuration items (to be used by admins only).
      tags:
      - Configurations
      parameters:
      - name: user_id
        in: path
        description: The unique identifier of the user.
        required: true
        schema:
          type: string
      - name: key_names
        in: path
        description: Keys of the configuration items that will be deleted.
        required: true
        schema:
          type: array
          items:
            type: string
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserConfigurationItem'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        default:
          $ref: '#/components/responses/Unexpected'
components:
  responses:
    Unexpected:
      description: Unexpected error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/EndpointError'
    Unauthorized:
      description: Unauthorized - Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/EndpointError'
    NotFound:
      description: Not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/EndpointError'
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/EndpointError'
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/EndpointError'
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/EndpointError'
  schemas:
    EndpointError:
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
          description: Error code
        message:
          type: string
          description: Error message
    GlobalConfigurationItem:
      required:
      - key_name
      - string_value
      - value_type
      - can_overwrite
      - is_public
      type: object
      properties:
        key_name:
          type: string
        string_value:
          type: string
        value_type:
          type: string
        can_overwrite:
          type: boolean
        upper_bound:
          type: number
        is_public:
          type: boolean
        is_read_only:
          type: boolean
        is_encrypted:
          type: boolean
        description:
          type: string
        category:
          type: string
        needs_propagation:
          type: boolean
          description: 'When true, mux resolves this key per-user (with role-priority

            overrides) and caches the resolved value for the duration of

            the global `config_cache_ttl_seconds` setting. The UI uses this

            flag to render an info icon explaining that changes take up to

            the cache-TTL seconds to propagate across all mux replicas.

            '
    UserConfigurationItem:
      required:
      - key_name
      - string_value
      - value_type
      type: object
      properties:
        key_name:
          type: string
        string_value:
          type: string
        value_type:
          type: string
        updated_at:
          type: string
          format: date-time
          description: When this override was last saved.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Using an API key generated by H2OGPTe