Huma

Huma Deployment API

The Deployment API from Huma — 52 operation(s) for deployment.

GitHub OpenAPI

Operations 66

POST /api/extensions/v1/deployment Create Deployment #
GET /api/extensions/v1/deployment/{deployment_id} Retrieve Deployment #
PUT /api/extensions/v1/deployment/{deployment_id} Update Deployment #
POST /api/extensions/v1/deployment/{deployment_id}/component-config Create Component Config #
PUT /api/extensions/v1/deployment/{deployment_id}/component-config Update Component Config #
DELETE /api/extensions/v1/deployment/{deployment_id}/component-config/{component_name} Delete Component Config #
GET /api/extensions/v1/deployment/{deployment_id}/devices List Deployment Devices #
POST /api/extensions/v1/deployment/{deployment_id}/devices Update Deployment Devices #
GET /api/extensions/v1/deployment/{deployment_id}/econsent Retrieve Latest Econsent #
POST /api/extensions/v1/deployment/{deployment_id}/econsent Create Econsent #
POST /api/extensions/v1/deployment/{deployment_id}/encrypt Encrypt Value #
POST /api/extensions/v1/deployment/{deployment_id}/export/localizations Export Deployment Localizations #
POST /api/extensions/v1/deployment/{deployment_id}/generate-master-translation Generate Master Translation #
POST /api/extensions/v1/deployment/{deployment_id}/import/localizations Import Deployment Localizations #
POST /api/extensions/v1/deployment/{deployment_id}/key-action Create Key Action Config #
PUT /api/extensions/v1/deployment/{deployment_id}/key-action/{key_action_id} Update Key Action Config #
DELETE /api/extensions/v1/deployment/{deployment_id}/key-action/{key_action_id} Delete Key Action Config #
POST /api/extensions/v1/deployment/{deployment_id}/key-actions Retrieve Deployment Key Actions #
GET /api/extensions/v1/deployment/{deployment_id}/labels Retrieve Deployment Labels #
POST /api/extensions/v1/deployment/{deployment_id}/labels Create Deployment Labels #
PUT /api/extensions/v1/deployment/{deployment_id}/labels/{label_id} Update Deployment Labels #
DELETE /api/extensions/v1/deployment/{deployment_id}/labels/{label_id} Delete Deployment Label #
POST /api/extensions/v1/deployment/{deployment_id}/learn-section Create Learn Section #
PUT /api/extensions/v1/deployment/{deployment_id}/learn-section/{section_id} Update Learn Section #
DELETE /api/extensions/v1/deployment/{deployment_id}/learn-section/{section_id} Delete Learn Section #
POST /api/extensions/v1/deployment/{deployment_id}/learn-section/{section_id}/article Create Article #
PUT /api/extensions/v1/deployment/{deployment_id}/learn-section/{section_id}/article/{article_id} Update Article #
DELETE /api/extensions/v1/deployment/{deployment_id}/learn-section/{section_id}/article/{article_id} Delete Article #
PUT /api/extensions/v1/deployment/{deployment_id}/learn-section/{section_id}/article/reorder Reorder Learn Articles #
PUT /api/extensions/v1/deployment/{deployment_id}/learn-section/reorder Reorder Learn Sections #
GET /api/extensions/v1/deployment/{deployment_id}/localizable-fields Retrieve Localizable Fields #
POST /api/extensions/v1/deployment/{deployment_id}/module-config Create Module Config #
PUT /api/extensions/v1/deployment/{deployment_id}/module-config Update Module Config #
DELETE /api/extensions/v1/deployment/{deployment_id}/module-config/{module_config_id} Delete Module Config #
PUT /api/extensions/v1/deployment/{deployment_id}/module-config/reorder Reorder Module Configs #
POST /api/extensions/v1/deployment/{deployment_id}/module-configs Create Module Configs #
POST /api/extensions/v1/deployment/{deployment_id}/onboarding-module-config Create Onboarding Module Config #
PUT /api/extensions/v1/deployment/{deployment_id}/onboarding-module-config Update Onboarding Module Config #
DELETE /api/extensions/v1/deployment/{deployment_id}/onboarding-module-config/{onboarding_id} Delete Onboarding Module Config #
PUT /api/extensions/v1/deployment/{deployment_id}/onboarding-module-config/reorder Reorder Onboarding Module Configs #
PUT /api/extensions/v1/deployment/{deployment_id}/role Create Or Update Roles #
POST /api/extensions/v1/deployment/{deployment_id}/update-localizations Create Localization #
GET /api/extensions/v1/deployment/{deployment_id}/version/{version_number} Retrieve Deployment By Version Number #
POST /api/extensions/v1/deployment/file-library Add Files To Library #
GET /api/extensions/v1/deployment/file-library/{library_id} Retrieve File Libraries #
POST /api/extensions/v1/deployment/full Create Full Deployment #
GET /api/extensions/v1/deployment/learn-section/cms/{article_id} Get Cms Article #
GET /api/extensions/v1/deployment/learn-section/cms/search Search Cms Articles #
GET /api/extensions/v1/deployment/modules Retrieve Modules #
POST /api/extensions/v1/deployment/move Move Deployments #
POST /api/extensions/v1/deployment/search Retrieve Deployments #
POST /api/extensions/v1/deployment/template Create Deployment Template #
GET /api/extensions/v1/deployment/template/{template_id} Retrieve Deployment Template #
PUT /api/extensions/v1/deployment/template/{template_id} Update Deployment Template #
DELETE /api/extensions/v1/deployment/template/{template_id} Delete Deployment Template #
GET /api/extensions/v1/deployment/templates Retrieve Deployment Templates #
POST /api/extensions/v1/deployment/user/email/send Send Email To Patients #
POST /api/extensions/v1/deployment/user/message/send Send Message To Patient List #
POST /api/extensions/v1/deployment/validate-questionnaire-dimensions Validate Questionnaire Dimensions #
POST /api/sdk/v1/deployment/{deployment_id}/draft Create Draft #
POST /api/sdk/v1/deployment/{deployment_id}/publish Publish Draft #
GET /api/sdk/v1/deployment/{deployment_id}/releases Retrieve Releases #
POST /api/sdk/v1/deployment/{deployment_id}/rollback Rollback Draft #
GET /api/sdk/v1/deployment/{deployment_id}/versions Retrieve Versions #

Documentation

📖
APIReference
https://workspace-gcp-uk.api.huma.com/docs
📖
Documentation
https://docs.huma.com/api-integration/intro
📖
GettingStarted
https://docs.huma.com/quick-start/backend/
📖
Authentication
https://docs.huma.com/quick-start/backend/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/huma/refs/heads/main/openapi/huma-deployment-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/huma/refs/heads/main/errors/huma-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/huma/refs/heads/main/data-model/huma-data-model.yml

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/huma-deployment-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

huma-deployment-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Huma Platform Deployment API
  version: 1.0.0
  description: Huma Platform
servers:
- url: https://workspace-gcp-uk.api.huma.com/api/integration/v1
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: Deployment
paths:
  /api/extensions/v1/deployment:
    post:
      operationId: api_extensions_v1_deployment_create_[create_deployment]
      summary: Create Deployment
      tags:
      - Deployment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDeploymentRequestObjectDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateDeploymentRequestObjectDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CreateDeploymentRequestObjectDRF'
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultIdResponseObjectDRF'
          description: ''
  /api/extensions/v1/deployment/{deployment_id}:
    get:
      operationId: api_extensions_v1_deployment_retrieve_[retrieve_deployment]
      summary: Retrieve Deployment
      parameters:
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Deployment
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentResponseObjectDRF'
          description: ''
    put:
      operationId: api_extensions_v1_deployment_update_[update_deployment]
      summary: Update Deployment
      parameters:
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Deployment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDeploymentRequestBodyDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateDeploymentRequestBodyDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UpdateDeploymentRequestBodyDRF'
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultIdResponseObjectDRF'
          description: ''
  /api/extensions/v1/deployment/{deployment_id}/component-config:
    post:
      operationId: api_extensions_v1_deployment_component_config_create_[create_component_config]
      summary: Create Component Config
      parameters:
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Deployment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComponentConfigRequestBodyDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ComponentConfigRequestBodyDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ComponentConfigRequestBodyDRF'
        required: true
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '201':
          description: No response body
    put:
      operationId: api_extensions_v1_deployment_component_config_update_[update_component_config]
      summary: Update Component Config
      parameters:
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Deployment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ComponentConfigRequestBodyDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ComponentConfigRequestBodyDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ComponentConfigRequestBodyDRF'
        required: true
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          description: No response body
  /api/extensions/v1/deployment/{deployment_id}/component-config/{component_name}:
    delete:
      operationId: api_extensions_v1_deployment_component_config_destroy_[delete_component_config]
      summary: Delete Component Config
      parameters:
      - in: path
        name: component_name
        schema:
          type: string
        required: true
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Deployment
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '204':
          description: No response body
  /api/extensions/v1/deployment/{deployment_id}/consent:
    get:
      operationId: api_extensions_v1_deployment_consent_retrieve_[retrieve_latest_consent]
      summary: Retrieve Latest Consent
      parameters:
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Deployment
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConsentResponseObjectDRF'
          description: ''
    post:
      operationId: api_extensions_v1_deployment_consent_create_[create_consent]
      summary: Create Consent
      parameters:
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Deployment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateConsentRequestObjectDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateConsentRequestObjectDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CreateConsentRequestObjectDRF'
        required: true
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultIdResponseObjectDRF'
          description: ''
  /api/extensions/v1/deployment/{deployment_id}/devices:
    get:
      operationId: api_extensions_v1_deployment_devices_retrieve_[list_deployment_devices]
      summary: List Deployment Devices
      parameters:
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Deployment
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceCategoriesDRF'
          description: ''
    post:
      operationId: api_extensions_v1_deployment_devices_create_[update_deployment_devices]
      summary: Update Deployment Devices
      parameters:
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Deployment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeviceConnectionIdDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/DeviceConnectionIdDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/DeviceConnectionIdDRF'
        required: true
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeviceConnectionIdDRF'
          description: ''
  /api/extensions/v1/deployment/{deployment_id}/econsent:
    get:
      operationId: api_extensions_v1_deployment_econsent_retrieve_[retrieve_latest_econsent]
      summary: Retrieve Latest Econsent
      parameters:
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Deployment
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EConsentResponseObjectDRF'
          description: ''
    post:
      operationId: api_extensions_v1_deployment_econsent_create_[create_econsent]
      summary: Create Econsent
      parameters:
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Deployment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEConsentRequestObjectDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateEConsentRequestObjectDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CreateEConsentRequestObjectDRF'
        required: true
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultIdResponseObjectDRF'
          description: ''
  /api/extensions/v1/deployment/{deployment_id}/encrypt:
    post:
      operationId: api_extensions_v1_deployment_encrypt_create_[encrypt_value]
      summary: Encrypt Value
      parameters:
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Deployment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EncryptValueRequestObjectBodyDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/EncryptValueRequestObjectBodyDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/EncryptValueRequestObjectBodyDRF'
        required: true
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EncryptValueResponseObjectDRF'
          description: ''
  /api/extensions/v1/deployment/{deployment_id}/export/localizations:
    post:
      operationId: api_extensions_v1_deployment_export_localizations_create_[export_deployment_localizations]
      summary: Export Deployment Localizations
      parameters:
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Deployment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetrieveLocalizationsRequestObjectDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RetrieveLocalizationsRequestObjectDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/RetrieveLocalizationsRequestObjectDRF'
        required: true
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          description: No response body
  /api/extensions/v1/deployment/{deployment_id}/generate-master-translation:
    post:
      operationId: api_extensions_v1_deployment_generate_master_translation_create_[generate_master_translation]
      summary: Generate Master Translation
      parameters:
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Deployment
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateMasterTranslationsResponseObjectDRF'
          description: ''
  /api/extensions/v1/deployment/{deployment_id}/import/localizations:
    post:
      operationId: api_extensions_v1_deployment_import_localizations_create_[import_deployment_localizations]
      summary: Import Deployment Localizations
      parameters:
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Deployment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportLocalizationsRequestObjectDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/ImportLocalizationsRequestObjectDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ImportLocalizationsRequestObjectDRF'
        required: true
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultIdResponseObjectDRF'
          description: ''
  /api/extensions/v1/deployment/{deployment_id}/key-action:
    post:
      operationId: api_extensions_v1_deployment_key_action_create_[create_key_action_config]
      summary: Create Key Action Config
      parameters:
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Deployment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateKeyActionConfigRequestObjectDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateKeyActionConfigRequestObjectDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CreateKeyActionConfigRequestObjectDRF'
        required: true
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultIdResponseObjectDRF'
          description: ''
  /api/extensions/v1/deployment/{deployment_id}/key-action/{key_action_id}:
    put:
      operationId: api_extensions_v1_deployment_key_action_update_[update_key_action_config]
      summary: Update Key Action Config
      parameters:
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      - in: path
        name: key_action_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Deployment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateKeyActionConfigRequestObjectDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateKeyActionConfigRequestObjectDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CreateKeyActionConfigRequestObjectDRF'
        required: true
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultIdResponseObjectDRF'
          description: ''
    delete:
      operationId: api_extensions_v1_deployment_key_action_destroy_[delete_key_action_config]
      summary: Delete Key Action Config
      parameters:
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      - in: path
        name: key_action_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Deployment
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '204':
          description: No response body
  /api/extensions/v1/deployment/{deployment_id}/key-actions:
    post:
      operationId: api_extensions_v1_deployment_key_actions_create_[retrieve_deployment_key_actions]
      summary: Retrieve Deployment Key Actions
      parameters:
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Deployment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RetrieveDeploymentKeyActionsRequestObjectBodyDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RetrieveDeploymentKeyActionsRequestObjectBodyDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/RetrieveDeploymentKeyActionsRequestObjectBodyDRF'
        required: true
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveDeploymentKeyActionsResponseObjectDRF'
          description: ''
  /api/extensions/v1/deployment/{deployment_id}/labels:
    get:
      operationId: api_extensions_v1_deployment_labels_retrieve_[retrieve_deployment_labels]
      summary: Retrieve Deployment Labels
      parameters:
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Deployment
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveDeploymentLabelsResponseObjectDRF'
          description: ''
    post:
      operationId: api_extensions_v1_deployment_labels_create_[create_deployment_labels]
      summary: Create Deployment Labels
      parameters:
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Deployment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLabelsRequestObjectBodyDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateLabelsRequestObjectBodyDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CreateLabelsRequestObjectBodyDRF'
        required: true
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListIdResponseObjectDRF'
          description: ''
  /api/extensions/v1/deployment/{deployment_id}/labels/{label_id}:
    put:
      operationId: api_extensions_v1_deployment_labels_update_[update_deployment_labels]
      summary: Update Deployment Labels
      parameters:
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      - in: path
        name: label_id
        schema:
          type: string
        required: true
      tags:
      - Deployment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateLabelRequestObjectBodyDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateLabelRequestObjectBodyDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UpdateLabelRequestObjectBodyDRF'
        required: true
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultIdResponseObjectDRF'
          description: ''
    delete:
      operationId: api_extensions_v1_deployment_labels_destroy_[delete_deployment_label]
      summary: Delete Deployment Label
      parameters:
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      - in: path
        name: label_id
        schema:
          type: string
        required: true
      tags:
      - Deployment
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '204':
          description: No response body
  /api/extensions/v1/deployment/{deployment_id}/learn-section:
    post:
      operationId: api_extensions_v1_deployment_learn_section_create_[create_learn_section]
      summary: Create Learn Section
      parameters:
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Deployment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLearnSectionRequestObjectDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateLearnSectionRequestObjectDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CreateLearnSectionRequestObjectDRF'
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultIdResponseObjectDRF'
          description: ''
  /api/extensions/v1/deployment/{deployment_id}/learn-section/{section_id}:
    put:
      operationId: api_extensions_v1_deployment_learn_section_update_[update_learn_section]
      summary: Update Learn Section
      parameters:
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      - in: path
        name: section_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Deployment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LearnSectionDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/LearnSectionDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/LearnSectionDRF'
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultIdResponseObjectDRF'
          description: ''
    delete:
      operationId: api_extensions_v1_deployment_learn_section_destroy_[delete_learn_section]
      summary: Delete Learn Section
      parameters:
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      - in: path
        name: section_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Deployment
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '204':
          description: No response body
  /api/extensions/v1/deployment/{deployment_id}/learn-section/{section_id}/article:
    post:
      operationId: api_extensions_v1_deployment_learn_section_article_create_[create_article]
      summary: Create Article
      parameters:
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      - in: path
        name: section_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Deployment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateLearnArticleRequestObjectDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateLearnArticleRequestObjectDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CreateLearnArticleRequestObjectDRF'
        required: true
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultIdResponseObjectDRF'
          description: ''
  /api/extensions/v1/deployment/{deployment_id}/learn-section/{section_id}/article/{article_id}:
    put:
      operationId: api_extensions_v1_deployment_learn_section_article_update_[update_article]
      summary: Update Article
      parameters:
      - in: path
        name: article_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      - in: path
        name: section_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Deployment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LearnArticleDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/LearnArticleDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/LearnArticleDRF'
        required: true
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResultIdResponseObjectDRF'
          description: ''
    delete:
      operationId: api_extensions_v1_deployment_learn_section_article_destroy_[delete_article]
      summary: Delete Article
      parameters:
      - in: path
        name: article_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      - in: path
        name: section_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Deployment
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '204':
          description: No response body
  /api/extensions/v1/deployment/{deployment_id}/learn-section/{section_id}/article/reorder:
    put:
      operationId: api_extensions_v1_deployment_learn_section_article_reorder_update_[reorder_learn_articles]
      summary: Reorder Learn Articles
      parameters:
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      - in: path
        name: section_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Deployment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderUpdateObjectDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/OrderUpdateObjectDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/OrderUpdateObjectDRF'
        required: true
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListIdResponseObjectDRF'
          description: ''
  /api/extensions/v1/deployment/{deployment_id}/learn-section/reorder:
    put:
      operationId: api_extensions_v1_deployment_learn_section_reorder_update_[reorder_learn_sections]
      summary: Reorder Learn Sections
      parameters:
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Deployment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderUpdateObjectDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/OrderUpdateObjectDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/OrderUpdateObjectDRF'
        required: true
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListIdResponseObjectDRF'
          description: ''
  /api/extensions/v1/deployment/{deployment_id}/localizable-fields:
    get:
      operationId: api_extensions_v1_deployment_localizable_fields_retrieve_[retrieve_localizable_fields]
      summary: Retrieve Localizable Fields
      parameters:
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Deployment
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveLocalizableFieldsResponseObjectDRF'
          description: ''
  /api/extensions/v1/deployment/{deployment_id}/module-config:
    post:
      operationId: api_extensions_v1_deployment_module_config_create_[create_module_config]
      summary: Create Module Config
      parameters:
      - in: path
        name: deployment_id
        schema:
          type: string
          pattern: ^[a-f0-9]{24}$
        required: true
      tags:
      - Deployment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateModuleConfigRequestObjectDRF'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateModuleConfigRequestObjectDRF'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CreateModuleConfigRequestObjectDRF'
        required: true
      security:
      - JWT Auth: []
      - Hawk Auth: []
      - jwtAuth: []
      responses:
        '201':
          content:
  

# --- truncated at 32 KB (139 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/huma/refs/heads/main/openapi/huma-deployment-api-openapi.yml