# Huma Deployment API

**Canonical:** https://apis.io/apis/huma/huma-deployment-api/  
**Provider:** Huma — https://apis.io/providers/huma/  
**Base URL:** https://workspace-gcp-uk.api.huma.com/api/integration/v1  
**Documentation:** https://docs.huma.com/api-integration/intro

Huma Deployment API is one of 77 APIs that [Huma](https://apis.io/providers/huma/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Deployment. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, a getting-started guide, and authentication docs.

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

## Operations (60 of 66)

| Method | Path | Summary |
|---|---|---|
| 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}/consent` | Retrieve Latest Consent |
| POST | `/api/extensions/v1/deployment/{deployment_id}/consent` | Create Consent |
| 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 |

…and 6 more operations. They are listed in full on the page.

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/huma/refs/heads/main/openapi/huma-deployment-api-openapi.yml
- **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/
- **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

## Other Huma APIs (12)

- [Huma Mobile & Web SDK](https://apis.io/apis/huma/huma-mobile-sdk/)
- [Huma AI Engine API](https://apis.io/apis/huma/huma-ai-engine-api/)
- [Huma Appointment API](https://apis.io/apis/huma/huma-appointment-api/)
- [Huma Assets API](https://apis.io/apis/huma/huma-assets-api/)
- [Huma Audit Log API](https://apis.io/apis/huma/huma-audit-log-api/)
- [Huma Auth API](https://apis.io/apis/huma/huma-auth-api/)
- [Huma Authorization Admin API](https://apis.io/apis/huma/huma-authorization-admin-api/)
- [Huma Autocomplete API](https://apis.io/apis/huma/huma-autocomplete-api/)
- [Huma Billing API](https://apis.io/apis/huma/huma-billing-api/)
- [Huma Billing Portal Route API](https://apis.io/apis/huma/huma-billing-portal-route-api/)
- [Huma Builder API](https://apis.io/apis/huma/huma-builder-api/)
- [Huma Calendar Route API](https://apis.io/apis/huma/huma-calendar-route-api/)

## Tags

Deployment

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/huma/huma-deployment-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/huma/.
