HUD

HUD Env Vars API

The env-vars API from HUD — 4 operation(s) for env-vars.

GitHub OpenAPI
Business capability
Configuration & Secrets Management BC-4210.60

Operations 6

GET /v2/env-vars List Env Vars #
POST /v2/env-vars Create Env Var #
PATCH /v2/env-vars/{var_id} Update Env Var #
DELETE /v2/env-vars/{var_id} Delete Env Var #
PUT /v2/env-vars/batch Batch Replace Env Vars #
POST /v2/env-vars/check Check Env Var Completeness #

Documentation

📖
APIReference
https://api.beta.hud.ai/docs
📖
Documentation
https://docs.hud.ai/platform/rest-api

Specifications

⚙
OpenAPI
https://artifacts.apis.io/hud-ai/openapi/hud-ai-env-vars-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/hud-ai/json-schema/hud-ai-trace-info-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/hud-ai/json-schema/hud-ai-model-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/hud-ai/json-schema/hud-ai-registry-detail-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/hud-ai/json-schema/hud-ai-build-register-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/hud-ai/json-schema/hud-ai-trace-analysis-context-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/hud-ai/json-schema/hud-ai-build-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/hud-ai:hud-ai-env-vars-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

hud-ai-env-vars-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: HUD Platform Env Vars API
  version: 2.0.0
tags:
- name: env-vars
paths:
  /v2/env-vars:
    get:
      tags:
      - env-vars
      summary: List Env Vars
      description: List a registry's runtime env vars with masked values.
      operationId: list_env_vars_v2_env_vars_get
      parameters:
      - name: registry_id
        in: query
        required: true
        schema:
          type: string
          format: uuid
          description: Registry to list env vars for.
          title: Registry Id
        description: Registry to list env vars for.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegistryEnvVarsListResponse'
        '400':
          description: Invalid or malformed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Caller may not access this resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Referenced entity does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Resource already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: Rate limit exceeded; wait at least Retry-After seconds
          headers:
            Retry-After:
              description: Seconds until the request budget has room
              schema:
                type: integer
                minimum: 0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: The server is at capacity; retry after Retry-After seconds
          headers:
            Retry-After:
              description: Seconds to wait before retrying
              schema:
                type: integer
                minimum: 0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    post:
      tags:
      - env-vars
      summary: Create Env Var
      description: Set a registry env var, creating it or updating an existing one by name.
      operationId: create_env_var_v2_env_vars_post
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegistryEnvVarCreateRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegistryEnvVarItem'
        '400':
          description: Invalid or malformed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Caller may not access this resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Referenced entity does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Resource already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: Rate limit exceeded; wait at least Retry-After seconds
          headers:
            Retry-After:
              description: Seconds until the request budget has room
              schema:
                type: integer
                minimum: 0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: The server is at capacity; retry after Retry-After seconds
          headers:
            Retry-After:
              description: Seconds to wait before retrying
              schema:
                type: integer
                minimum: 0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v2/env-vars/{var_id}:
    patch:
      tags:
      - env-vars
      summary: Update Env Var
      description: Update a registry env var's value.
      operationId: update_env_var_v2_env_vars__var_id__patch
      parameters:
      - name: var_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Var Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegistryEnvVarUpdateRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegistryEnvVarItem'
        '400':
          description: Invalid or malformed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Caller may not access this resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Referenced entity does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Resource already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: Rate limit exceeded; wait at least Retry-After seconds
          headers:
            Retry-After:
              description: Seconds until the request budget has room
              schema:
                type: integer
                minimum: 0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: The server is at capacity; retry after Retry-After seconds
          headers:
            Retry-After:
              description: Seconds to wait before retrying
              schema:
                type: integer
                minimum: 0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      tags:
      - env-vars
      summary: Delete Env Var
      description: Delete a registry env var.
      operationId: delete_env_var_v2_env_vars__var_id__delete
      parameters:
      - name: var_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Var Id
      responses:
        '204':
          description: Successful Response
        '400':
          description: Invalid or malformed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Caller may not access this resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Referenced entity does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Resource already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: Rate limit exceeded; wait at least Retry-After seconds
          headers:
            Retry-After:
              description: Seconds until the request budget has room
              schema:
                type: integer
                minimum: 0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: The server is at capacity; retry after Retry-After seconds
          headers:
            Retry-After:
              description: Seconds to wait before retrying
              schema:
                type: integer
                minimum: 0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v2/env-vars/batch:
    put:
      tags:
      - env-vars
      summary: Batch Replace Env Vars
      description: Replace a registry's full env var set with the given variables.
      operationId: batch_replace_env_vars_v2_env_vars_batch_put
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegistryEnvVarBatchRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegistryEnvVarBatchResponse'
        '400':
          description: Invalid or malformed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Caller may not access this resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Referenced entity does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Resource already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: Rate limit exceeded; wait at least Retry-After seconds
          headers:
            Retry-After:
              description: Seconds until the request budget has room
              schema:
                type: integer
                minimum: 0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: The server is at capacity; retry after Retry-After seconds
          headers:
            Retry-After:
              description: Seconds to wait before retrying
              schema:
                type: integer
                minimum: 0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /v2/env-vars/check:
    post:
      tags:
      - env-vars
      summary: Check Env Var Completeness
      description: Check whether each registry has all env vars its manifest requires.
      operationId: check_env_var_completeness_v2_env_vars_check_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegistryEnvVarCheckRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RegistryEnvVarCheckResponse'
        '400':
          description: Invalid or malformed request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Caller may not access this resource
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Referenced entity does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: Resource already exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '429':
          description: Rate limit exceeded; wait at least Retry-After seconds
          headers:
            Retry-After:
              description: Seconds until the request budget has room
              schema:
                type: integer
                minimum: 0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: The server is at capacity; retry after Retry-After seconds
          headers:
            Retry-After:
              description: Seconds to wait before retrying
              schema:
                type: integer
                minimum: 0
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    RegistryEnvVarCreateRequest:
      properties:
        registry_id:
          type: string
          format: uuid
          title: Registry Id
        name:
          type: string
          title: Name
          description: Environment variable name. Lowercase letters are uppercased and hyphens become underscores; all other characters are rejected.
        value:
          type: string
          title: Value
      type: object
      required:
      - registry_id
      - name
      - value
      title: RegistryEnvVarCreateRequest
    RegistryEnvVarCheckItem:
      properties:
        registry_id:
          type: string
          format: uuid
          title: Registry Id
        required_vars:
          items:
            type: string
          type: array
          title: Required Vars
        configured_vars:
          items:
            type: string
          type: array
          title: Configured Vars
        missing_vars:
          items:
            type: string
          type: array
          title: Missing Vars
        is_complete:
          type: boolean
          title: Is Complete
      type: object
      required:
      - registry_id
      - required_vars
      - configured_vars
      - missing_vars
      - is_complete
      title: RegistryEnvVarCheckItem
    RegistryEnvVarCheckResponse:
      properties:
        environments:
          items:
            $ref: '#/components/schemas/RegistryEnvVarCheckItem'
          type: array
          title: Environments
      type: object
      required:
      - environments
      title: RegistryEnvVarCheckResponse
    RegistryEnvVarBatchRequest:
      properties:
        registry_id:
          type: string
          format: uuid
          title: Registry Id
        variables:
          items:
            $ref: '#/components/schemas/RegistryEnvVarBatchItem'
          type: array
          title: Variables
      type: object
      required:
      - registry_id
      - variables
      title: RegistryEnvVarBatchRequest
    RegistryEnvVarBatchResponse:
      properties:
        created:
          type: integer
          title: Created
        updated:
          type: integer
          title: Updated
        deleted:
          type: integer
          title: Deleted
      type: object
      required:
      - created
      - updated
      - deleted
      title: RegistryEnvVarBatchResponse
    ErrorResponse:
      properties:
        error:
          type: string
          title: Error
        source:
          $ref: '#/components/schemas/ErrorSource'
        detail:
          type: string
          title: Detail
      type: object
      required:
      - error
      - source
      - detail
      title: ErrorResponse
      description: The uniform `{error, source, detail}` envelope returned for every 4xx/5xx.
    RegistryEnvVarItem:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        registry_id:
          type: string
          format: uuid
          title: Registry Id
        name:
          type: string
          title: Name
        value:
          anyOf:
          - type: string
          - type: 'null'
          title: Value
        masked_value:
          anyOf:
          - type: string
          - type: 'null'
          title: Masked Value
      type: object
      required:
      - id
      - registry_id
      - name
      title: RegistryEnvVarItem
    RegistryEnvVarsListResponse:
      properties:
        variables:
          items:
            $ref: '#/components/schemas/RegistryEnvVarItem'
          type: array
          title: Variables
      type: object
      required:
      - variables
      title: RegistryEnvVarsListResponse
    RegistryEnvVarCheckRequest:
      properties:
        registry_ids:
          items:
            type: string
            format: uuid
          type: array
          title: Registry Ids
      type: object
      required:
      - registry_ids
      title: RegistryEnvVarCheckRequest
    ErrorSource:
      type: string
      enum:
      - user
      - platform
      - provider
      title: ErrorSource
      description: 'Who is at fault for a failure.


        ``user``: the customer''s input, account, environment, or agent code.

        ``platform``: HUD infrastructure or a broken platform invariant.

        ``provider``: a third-party dependency (cloud runtime, upstream LLM API).'
    HTTPValidationError:
      title: HTTPValidationError
      type: object
      properties:
        error:
          type: string
          const: validation_error
          title: Error
        source:
          type: string
          enum:
          - user
          - platform
          - provider
          title: Source
        detail:
          type: string
          title: Detail
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Errors
      required:
      - error
      - source
      - detail
      - errors
    RegistryEnvVarUpdateRequest:
      properties:
        value:
          anyOf:
          - type: string
          - type: 'null'
          title: Value
      type: object
      title: RegistryEnvVarUpdateRequest
    ValidationError:
      title: ValidationError
      type: object
      properties:
        type:
          type: string
          title: Error Type
        loc:
          type: array
          items:
            anyOf:
            - type: string
            - type: integer
          title: Location
        msg:
          type: string
          title: Message
      required:
      - type
      - loc
      - msg
    RegistryEnvVarBatchItem:
      properties:
        name:
          type: string
          title: Name
          description: Environment variable name. Lowercase letters are uppercased and hyphens become underscores; all other characters are rejected.
        value:
          type: string
          title: Value
      type: object
      required:
      - name
      - value
      title: RegistryEnvVarBatchItem
x-hud-contract-scope: platform_public