How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Huma Deployment API

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

Huma Deployment API is one of 77 APIs that Huma publishes on the 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.

This API exposes 66 operations across 52 paths, and defines 139 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://workspace-gcp-uk.api.huma.com/api/integration/v1.

66 operations 52 paths 139 schemas 8 DELETE15 GET29 POST14 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://workspace-gcp-uk.api.huma.com/api/integration/v1
Authentication
API Key, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 3

Huma Deployment API declares 3 security schemes for authenticating requests. An API key is passed in the header as Authorization (Hawk_Auth). It accepts HTTP bearer tokens (JWT) (JWT_Auth). It accepts HTTP bearer tokens (JWT) (jwtAuth).

  • Hawk_Auth — Hawk MAC authentication. Paste a full Authorization header value. Example: Authorization: Hawk id="userId:clientId", ts=" ", nonce=" ", mac=" "[, hash=" "][, e…
  • JWT_Auth — Use HTTP Bearer auth with a JWT. Send the token in the Authorization header: Authorization: Bearer The token should contain standard claims plus projectId and…

Paths & Operations 66

Across 52 paths, the API surfaces 66 operations — 8 DELETE, 15 GET, 29 POST, 14 PUT. Each is listed below with its method, path, parameters, and response codes.

Deployment 66
POST
/api/extensions/v1/deployment
Create Deployment
api_extensions_v1_deployment_create_[create_deployment] body → 201
GET
/api/extensions/v1/deployment/{deployment_id}
Retrieve Deployment
api_extensions_v1_deployment_retrieve_[retrieve_deployment] 1 param → 200
PUT
/api/extensions/v1/deployment/{deployment_id}
Update Deployment
api_extensions_v1_deployment_update_[update_deployment] 1 param body → 200
POST
/api/extensions/v1/deployment/{deployment_id}/component-config
Create Component Config
api_extensions_v1_deployment_component_config_create_[create_component_config] 1 param body → 201
PUT
/api/extensions/v1/deployment/{deployment_id}/component-config
Update Component Config
api_extensions_v1_deployment_component_config_update_[update_component_config] 1 param body → 200
DELETE
/api/extensions/v1/deployment/{deployment_id}/component-config/{component_name}
Delete Component Config
api_extensions_v1_deployment_component_config_destroy_[delete_component_config] 2 params → 204
GET
/api/extensions/v1/deployment/{deployment_id}/consent
Retrieve Latest Consent
api_extensions_v1_deployment_consent_retrieve_[retrieve_latest_consent] 1 param → 200
POST
/api/extensions/v1/deployment/{deployment_id}/consent
Create Consent
api_extensions_v1_deployment_consent_create_[create_consent] 1 param body → 201
GET
/api/extensions/v1/deployment/{deployment_id}/devices
List Deployment Devices
api_extensions_v1_deployment_devices_retrieve_[list_deployment_devices] 1 param → 200
POST
/api/extensions/v1/deployment/{deployment_id}/devices
Update Deployment Devices
api_extensions_v1_deployment_devices_create_[update_deployment_devices] 1 param body → 200
GET
/api/extensions/v1/deployment/{deployment_id}/econsent
Retrieve Latest Econsent
api_extensions_v1_deployment_econsent_retrieve_[retrieve_latest_econsent] 1 param → 200
POST
/api/extensions/v1/deployment/{deployment_id}/econsent
Create Econsent
api_extensions_v1_deployment_econsent_create_[create_econsent] 1 param body → 201
POST
/api/extensions/v1/deployment/{deployment_id}/encrypt
Encrypt Value
api_extensions_v1_deployment_encrypt_create_[encrypt_value] 1 param body → 200
POST
/api/extensions/v1/deployment/{deployment_id}/export/localizations
Export Deployment Localizations
api_extensions_v1_deployment_export_localizations_create_[export_deployment_localizations] 1 param body → 200
POST
/api/extensions/v1/deployment/{deployment_id}/generate-master-translation
Generate Master Translation
api_extensions_v1_deployment_generate_master_translation_create_[generate_master_translation] 1 param → 200
POST
/api/extensions/v1/deployment/{deployment_id}/import/localizations
Import Deployment Localizations
api_extensions_v1_deployment_import_localizations_create_[import_deployment_localizations] 1 param body → 200
POST
/api/extensions/v1/deployment/{deployment_id}/key-action
Create Key Action Config
api_extensions_v1_deployment_key_action_create_[create_key_action_config] 1 param body → 201
PUT
/api/extensions/v1/deployment/{deployment_id}/key-action/{key_action_id}
Update Key Action Config
api_extensions_v1_deployment_key_action_update_[update_key_action_config] 2 params body → 200
DELETE
/api/extensions/v1/deployment/{deployment_id}/key-action/{key_action_id}
Delete Key Action Config
api_extensions_v1_deployment_key_action_destroy_[delete_key_action_config] 2 params → 204
POST
/api/extensions/v1/deployment/{deployment_id}/key-actions
Retrieve Deployment Key Actions
api_extensions_v1_deployment_key_actions_create_[retrieve_deployment_key_actions] 1 param body → 200
GET
/api/extensions/v1/deployment/{deployment_id}/labels
Retrieve Deployment Labels
api_extensions_v1_deployment_labels_retrieve_[retrieve_deployment_labels] 1 param → 200
POST
/api/extensions/v1/deployment/{deployment_id}/labels
Create Deployment Labels
api_extensions_v1_deployment_labels_create_[create_deployment_labels] 1 param body → 201
PUT
/api/extensions/v1/deployment/{deployment_id}/labels/{label_id}
Update Deployment Labels
api_extensions_v1_deployment_labels_update_[update_deployment_labels] 2 params body → 200
DELETE
/api/extensions/v1/deployment/{deployment_id}/labels/{label_id}
Delete Deployment Label
api_extensions_v1_deployment_labels_destroy_[delete_deployment_label] 2 params → 204
POST
/api/extensions/v1/deployment/{deployment_id}/learn-section
Create Learn Section
api_extensions_v1_deployment_learn_section_create_[create_learn_section] 1 param body → 201
PUT
/api/extensions/v1/deployment/{deployment_id}/learn-section/{section_id}
Update Learn Section
api_extensions_v1_deployment_learn_section_update_[update_learn_section] 2 params body → 200
DELETE
/api/extensions/v1/deployment/{deployment_id}/learn-section/{section_id}
Delete Learn Section
api_extensions_v1_deployment_learn_section_destroy_[delete_learn_section] 2 params → 204
POST
/api/extensions/v1/deployment/{deployment_id}/learn-section/{section_id}/article
Create Article
api_extensions_v1_deployment_learn_section_article_create_[create_article] 2 params body → 201
PUT
/api/extensions/v1/deployment/{deployment_id}/learn-section/{section_id}/article/{article_id}
Update Article
api_extensions_v1_deployment_learn_section_article_update_[update_article] 3 params body → 200
DELETE
/api/extensions/v1/deployment/{deployment_id}/learn-section/{section_id}/article/{article_id}
Delete Article
api_extensions_v1_deployment_learn_section_article_destroy_[delete_article] 3 params → 204
PUT
/api/extensions/v1/deployment/{deployment_id}/learn-section/{section_id}/article/reorder
Reorder Learn Articles
api_extensions_v1_deployment_learn_section_article_reorder_update_[reorder_learn_articles] 2 params body → 200
PUT
/api/extensions/v1/deployment/{deployment_id}/learn-section/reorder
Reorder Learn Sections
api_extensions_v1_deployment_learn_section_reorder_update_[reorder_learn_sections] 1 param body → 200
GET
/api/extensions/v1/deployment/{deployment_id}/localizable-fields
Retrieve Localizable Fields
api_extensions_v1_deployment_localizable_fields_retrieve_[retrieve_localizable_fields] 1 param → 200
POST
/api/extensions/v1/deployment/{deployment_id}/module-config
Create Module Config
api_extensions_v1_deployment_module_config_create_[create_module_config] 1 param body → 201
PUT
/api/extensions/v1/deployment/{deployment_id}/module-config
Update Module Config
api_extensions_v1_deployment_module_config_update_[update_module_config] 1 param body → 200
DELETE
/api/extensions/v1/deployment/{deployment_id}/module-config/{module_config_id}
Delete Module Config
api_extensions_v1_deployment_module_config_destroy_[delete_module_config] 2 params → 204
PUT
/api/extensions/v1/deployment/{deployment_id}/module-config/reorder
Reorder Module Configs
api_extensions_v1_deployment_module_config_reorder_update_[reorder_module_configs] 1 param body → 200
POST
/api/extensions/v1/deployment/{deployment_id}/module-configs
Create Module Configs
api_extensions_v1_deployment_module_configs_create_[create_module_configs] 1 param body → 200
POST
/api/extensions/v1/deployment/{deployment_id}/onboarding-module-config
Create Onboarding Module Config
api_extensions_v1_deployment_onboarding_module_config_create_[create_onboarding_module_config] 1 param body → 201
PUT
/api/extensions/v1/deployment/{deployment_id}/onboarding-module-config
Update Onboarding Module Config
api_extensions_v1_deployment_onboarding_module_config_update_[update_onboarding_module_config] 1 param body → 200
DELETE
/api/extensions/v1/deployment/{deployment_id}/onboarding-module-config/{onboarding_id}
Delete Onboarding Module Config
api_extensions_v1_deployment_onboarding_module_config_destroy_[delete_onboarding_module_config] 2 params → 204
PUT
/api/extensions/v1/deployment/{deployment_id}/onboarding-module-config/reorder
Reorder Onboarding Module Configs
api_extensions_v1_deployment_onboarding_module_config_reorder_update_[reorder_onboarding_module_configs] 1 param body → 200
PUT
/api/extensions/v1/deployment/{deployment_id}/role
Create Or Update Roles
api_extensions_v1_deployment_role_update_[create_or_update_roles] 1 param body → 200
POST
/api/extensions/v1/deployment/{deployment_id}/update-localizations
Create Localization
api_extensions_v1_deployment_update_localizations_create_[create_localization] 1 param body → 201
GET
/api/extensions/v1/deployment/{deployment_id}/version/{version_number}
Retrieve Deployment By Version Number
api_extensions_v1_deployment_version_retrieve_[retrieve_deployment_by_version_number] 2 params → 200
POST
/api/extensions/v1/deployment/file-library
Add Files To Library
api_extensions_v1_deployment_file_library_create_[add_files_to_library] body → 200
GET
/api/extensions/v1/deployment/file-library/{library_id}
Retrieve File Libraries
api_extensions_v1_deployment_file_library_retrieve_[retrieve_file_libraries] 4 params → 202
POST
/api/extensions/v1/deployment/full
Create Full Deployment
api_extensions_v1_deployment_full_create_[create_full_deployment] body → 201
GET
/api/extensions/v1/deployment/learn-section/cms/{article_id}
Get Cms Article
api_extensions_v1_deployment_learn_section_cms_retrieve_[get_cms_article] 1 param → 200
GET
/api/extensions/v1/deployment/learn-section/cms/search
Search Cms Articles
api_extensions_v1_deployment_learn_section_cms_search_retrieve_[search_cms_articles] 3 params → 200
GET
/api/extensions/v1/deployment/modules
Retrieve Modules
api_extensions_v1_deployment_modules_retrieve_[retrieve_modules] → 200
POST
/api/extensions/v1/deployment/move
Move Deployments
api_extensions_v1_deployment_move_create_[move_deployments] body → 200
POST
/api/extensions/v1/deployment/search
Retrieve Deployments
api_extensions_v1_deployment_search_create_[retrieve_deployments] body → 200
POST
/api/extensions/v1/deployment/template
Create Deployment Template
api_extensions_v1_deployment_template_create_[create_deployment_template] body → 201
GET
/api/extensions/v1/deployment/template/{template_id}
Retrieve Deployment Template
api_extensions_v1_deployment_template_retrieve_[retrieve_deployment_template] 2 params → 200
PUT
/api/extensions/v1/deployment/template/{template_id}
Update Deployment Template
api_extensions_v1_deployment_template_update_[update_deployment_template] 2 params body → 200
DELETE
/api/extensions/v1/deployment/template/{template_id}
Delete Deployment Template
api_extensions_v1_deployment_template_destroy_[delete_deployment_template] 2 params → 204
GET
/api/extensions/v1/deployment/templates
Retrieve Deployment Templates
api_extensions_v1_deployment_templates_retrieve_[retrieve_deployment_templates] 1 param → 200
POST
/api/extensions/v1/deployment/user/email/send
Send Email To Patients
api_extensions_v1_deployment_user_email_send_create_[send_email_to_patients] body → 200
POST
/api/extensions/v1/deployment/user/message/send
Send Message To Patient List
api_extensions_v1_deployment_user_message_send_create_[send_message_to_patient_list] body → 201
POST
/api/extensions/v1/deployment/validate-questionnaire-dimensions
Validate Questionnaire Dimensions
api_extensions_v1_deployment_validate_questionnaire_dimensions_create_[validate_questionnaire_dimensions] body → 200
POST
/api/sdk/v1/deployment/{deployment_id}/draft
Create Draft
api_sdk_v1_deployment_draft_create_[create_draft] 1 param → 201
POST
/api/sdk/v1/deployment/{deployment_id}/publish
Publish Draft
api_sdk_v1_deployment_publish_create_[publish_draft] 1 param body → 200
GET
/api/sdk/v1/deployment/{deployment_id}/releases
Retrieve Releases
api_sdk_v1_deployment_releases_retrieve_[retrieve_releases] 1 param → 200
POST
/api/sdk/v1/deployment/{deployment_id}/rollback
Rollback Draft
api_sdk_v1_deployment_rollback_create_[rollback_draft] 1 param body → 200
GET
/api/sdk/v1/deployment/{deployment_id}/versions
Retrieve Versions
api_sdk_v1_deployment_versions_retrieve_[retrieve_versions] 1 param → 200

Schemas 139

The contract defines 139 schemas that model the data the API accepts and returns. The most detailed are DeploymentResponseObjectDRF (59 properties), DeploymentDTODRF (56 properties), CreateDeploymentRequestObjectDRF (56 properties), CreateFullDeploymentRequestObjectDRF (56 properties). Each schema is shown below with its type and property counts.

MoveDeploymentsRequestObjectBodyDRF
object
3 properties 3 required
OffBoardingReasonsDRF
object
2 properties
UIWidgetDRF
object
5 properties 3 required
DeploymentStatsDRF
object
6 properties
RetrieveDeploymentLabelsResponseObjectDRF
object
9 properties 1 required
RollbackRequestBodyDRF
object
1 property 1 required
ModuleConfigDRF
object
25 properties 1 required
SurgeryDetailItemDRF
object
3 properties 2 required
RetrieveDeploymentKeyActionsResponseObjectDRF
object
1 property
DeploymentResponseObjectDRF
object
59 properties
FullDeploymentLearnDRF
object
5 properties
CreateLearnSectionRequestObjectDRF
object
7 properties
FeaturesDRF
object
30 properties
SsoDRF
object
3 properties
UpdateModuleConfigRequestObjectDRF
object
24 properties 1 required
SurgeryDetailsDRF
object
3 properties
ConsentResponseObjectDRF
object
13 properties 1 required
PAMIntegrationConfigDRF
object
5 properties 5 required
ComponentConfigRequestBodyDRF
object
2 properties 1 required
DeviceConnectionDRF
object
6 properties
UITabDRF
object
13 properties 5 required
OrgInfoDRF
object
2 properties
DeploymentLevelConfigurationDRF
object
4 properties
DeviceIntegrationDRF
object
1 property
LocalizationSchemaDRF
object
20 properties
SendMessageToPatientListRequestObjectBodyDRF
object
4 properties 2 required
LabelDRF
object
8 properties
CreateFullOnboardingConfigRequestObjectDRF
object
15 properties 2 required
BackgroundDRF
object
2 properties 2 required
SdkConfigDRF
object
5 properties
ThresholdRangeDRF
object
3 properties
ArticleDRF
object
8 properties 1 required
IntegrationDeviceDRF
object
7 properties 2 required
SearchCMSArticlesResponseDRF
object
3 properties 3 required
KeyActionConfigDRF
object
18 properties 4 required
BuilderDRF
object
1 property
SsoInfoDRF
object
16 properties 4 required
EmailTemplateDRF
object
3 properties 2 required
PatientPersonalizationDRF
object
2 properties
DeviceManufacturerDRF
object
4 properties 1 required
CreateConsentRequestObjectDRF
object
13 properties 1 required
ConsentDRF
object
13 properties 1 required
MoveUserReasonsDRF
object
2 properties
AuthorisedRepDRF
object
4 properties 4 required
StaticEventDRF
object
4 properties 3 required
SecurityDRF
object
2 properties 2 required
FootnoteDRF
object
3 properties
OnboardingModuleConfigDTODRF
object
15 properties 2 required
FeedbackTextsDRF
object
2 properties
GenderOptionTypeDRF
object
3 properties 2 required
S3ObjectDRF
object
3 properties 2 required
SummaryReportDRF
object
1 property
CreateFullDeploymentLearnSectionRequestObjectDRF
object
7 properties
ModuleSchemaDRF
object
2 properties
CreateLearnArticleRequestObjectDRF
object
9 properties 2 required
UsersInfoDRF
object
2 properties 1 required
ConsentSignatureDRF
object
7 properties 4 required
AddFilesToLibraryRequestObjectBodyDRF
object
3 properties 2 required
ReleaseDRF
object
4 properties
AdditionalConsentQuestionDRF
object
7 properties 4 required
RetrieveDeploymentsResponseObjectDRF
object
5 properties
ModuleGoalCreatedByDRF
object
2 properties
MessagingDRF
object
5 properties
BasePhoenixDynamicConfigDRF
object
2 properties
LocationDRF
object
9 properties
CreateFullKeyActionConfigRequestObjectDRF
object
18 properties 4 required
ReasonDRF
object
3 properties 2 required
DeploymentRoleUpdateObjectBodyDRF
object
1 property
EmailConfigDRF
object
2 properties
RagThresholdDRF
object
8 properties 6 required
RetrieveFilesInLibraryResponseObjectDRF
object
2 properties
EncryptValueRequestObjectBodyDRF
object
1 property 1 required
SeverityFilterDRF
object
2 properties 2 required
FeedbackTextDRF
object
3 properties 2 required
ListIdResponseObjectDRF
object
1 property
CreateKeyActionConfigRequestObjectDRF
object
18 properties 4 required
ConsentReviewDRF
object
3 properties 2 required
RetrieveLocalizableFieldsResponseObjectDRF
object
1 property
SurgeryDetailDRF
object
4 properties 2 required
RetrieveDeploymentKeyActionsRequestObjectBodyDRF
object
3 properties 2 required
ResultIdResponseObjectDRF
object
1 property
UpdateLabelRequestObjectBodyDRF
object
1 property 1 required
DeploymentDTODRF
object
56 properties
ClinicianOnlyFieldsDRF
object
1 property
ProfileFieldsDRF
object
31 properties
EncryptValueResponseObjectDRF
object
1 property
CreateEConsentRequestObjectDRF
object
16 properties 5 required
IntegrationConfigDRF
object
1 property
ProfileExtraIdsDRF
object
8 properties
AdditionalContactDetailsItemDRF
object
6 properties
StaticEventConfigDRF
object
3 properties 2 required
SearchResultDRF
object
6 properties 1 required
StatDRF
object
2 properties 1 required
RetrieveDeploymentTemplatesResponseObjectDRF
object
1 property
ModuleScheduleDRF
object
6 properties
LearnSectionDRF
object
7 properties
VersionsResponseObjectDRF
object
1 property
SendMessageToUserListResponseObjectDRF
object
1 property
EConsentSectionDRF
object
11 properties 2 required
LearnDRF
object
5 properties
ProfileDRF
object
3 properties
FeedbackConfigDRF
object
9 properties 1 required
OrderUpdateObjectDRF
object
2 properties 2 required
FeedBacksGroupedByRagDRF
object
2 properties 2 required
ConsentSectionOptionsDRF
object
5 properties 2 required
DeploymentEventDRF
object
10 properties
DeviceCategoriesDRF
object
1 property
UpdateDeploymentRequestBodyDRF
object
55 properties
ConsentSectionDRF
object
6 properties 1 required
LibraryFileObjectDRF
object
5 properties
FeedbackNotificationDataDRF
object
5 properties
DeploymentTemplateDTODRF
object
10 properties 3 required
RoleDTODRF
object
5 properties
ValidateQuestionnaireDimensionsRequestObjectDRF
object
1 property 1 required
CreateLabelsRequestObjectBodyDRF
object
1 property 1 required
PublishDeploymentRequestBodyDRF
object
1 property
SurgeryDateRuleDRF
object
2 properties
GenerateMasterTranslationsResponseObjectDRF
object
1 property
CreateFullDeploymentRequestObjectDRF
object
56 properties
EConsentDRF
object
16 properties 5 required
NotificationDataDRF
object
4 properties
SortFieldDRF
object
2 properties 2 required
LearnArticleDRF
object
9 properties 2 required
SendEmailToPatientsRequestObjectDRF
object
4 properties 2 required
ImportLocalizationsRequestObjectDRF
object
4 properties 3 required
EthnicityOptionDRF
object
3 properties 2 required
VariabilityFilterDRF
object
4 properties
CreateModuleConfigRequestObjectDRF
object
24 properties 1 required
ReleasesResponseObjectDRF
object
1 property
LearnArticleContentDRF
object
12 properties 1 required
CreateDeploymentRequestObjectDRF
object
56 properties
OkResponseDRF
object
1 property
RetrieveLocalizationsRequestObjectDRF
object
2 properties 1 required
DeviceConnectionIdDRF
object
1 property 1 required
EConsentResponseObjectDRF
object
16 properties 5 required
ModuleGoalDTODRF
object
9 properties
RetrieveDeploymentsRequestObjectDRF
object
8 properties
CreateMultipleModuleConfigsRequestObjectBodyDRF
object
1 property 1 required
DeviceCategoryDRF
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

huma-deployment-api-openapi.yml Raw ↑

Other APIs Huma publishes across the network.

Huma Mobile & Web SDK
Huma AI Engine API
Huma Appointment API
Huma Assets API
Huma Audit Log API
Huma Auth API
Huma Authorization Admin API
Huma Autocomplete API
Huma Billing API
Huma Billing Portal Route API
Huma Builder API
Huma Calendar Route API
Where this information came from

This is an independent, third-party profile of Huma Deployment API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.