Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Humanitec WorkloadProfile API

Workload Profiles provide the baseline configuration for Workloads in Applications in Humanitec. Developers can configure various features of a workload profile to suit their needs. Examples of features might be `schedules` used in Kubernetes CronJobs or `ingress` which might be used to expose Pods controlled by a Kubernetes Deployment.Workloads in Humanitec are implemented as Helm Charts which must implement a specific schema.

Humanitec WorkloadProfile API is one of 45 APIs that Humanitec publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include WorkloadProfile. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and authentication docs.

This API exposes 9 operations across 5 paths, and defines 14 schemas. It is described by OpenAPI 3.0.0, at version 0.28.24.

Requests are made against a single base URL, https://api.humanitec.io/.

9 operations 5 paths 14 schemas 1 DELETE5 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
0.28.24
Base URL
https://api.humanitec.io
Resource Areas
1

Paths & Operations 9

Across 5 paths, the API surfaces 9 operations — 1 DELETE, 5 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

WorkloadProfile 9

Workload Profiles provide the baseline configuration for Workloads in Applications in Humanitec. Developers can configure various features of a workload profile to suit their need…

GET
/orgs/{orgId}/workload-profiles
List workload profiles available to the organization.
listWorkloadProfiles 4 params → 200
POST
/orgs/{orgId}/workload-profiles
Create new Workload Profile
createWorkloadProfile 1 param body → 201400409
GET
/orgs/{orgId}/workload-profiles/{profileQid}
Get a Workload Profile
getWorkloadProfile 2 params → 200400404
PUT
/orgs/{orgId}/workload-profiles/{profileQid}
Update a Workload Profile
updateWorkloadProfile 2 params body → 200400404409
DELETE
/orgs/{orgId}/workload-profiles/{profileQid}
Delete a Workload Profile
deleteWorkloadProfile 2 params → 204400404
GET
/orgs/{orgId}/workload-profiles/{profileQid}/versions
List versions of the given workload profile.
listWorkloadProfileVersions 4 params → 200404
GET
/orgs/{orgId}/workload-profiles/{profileQid}/versions/latestdeprecated
Latest version of the given workload profile with optional constraint.
getLatestWorkloadProfileVersion 2 params → 200404
POST
/orgs/{orgId}/workload-profile-chart-versions
Add new Workload Profile Chart Version
createWorkloadProfileChartVersion 1 param body → 201400409
GET
/orgs/{orgId}/workload-profile-chart-versions
Workload Profile Chart Versions for the given organization.
listWorkloadProfileChartVersions 5 params → 200

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are WorkloadProfileResponse (12 properties), WorkloadProfileVersionResponse (10 properties), WorkloadProfileSpecDefinitionProperty (8 properties), WorkloadProfileRequest (6 properties). Each schema is shown below with its type and property counts.

WorkloadProfileRequest
object
Workload Profiles provide the baseline configuration for Workloads in Applications in Humanitec. Developers can configure various features of a workload profil…
6 properties 3 required
WorkloadProfileChartVersionResponse
object
Each Workload Profile Chart has one or more Versions associated with it.
5 properties 5 required
WorkloadProfileSpecDefinition
object
Workload spec definition
2 properties
WorkloadProfileUpdateRequest
object
The proposed properties to update a workload profile.
5 properties 2 required
WorkloadProfileSpecDefinitionRuntimePropertyType
string
HumanitecErrorResponse
object
HumanitecError represents a standard Humanitec Error
3 properties 2 required
WorkloadProfileSpecDefinitionProperties
object
Workload spec definition
WorkloadProfileSpecDefinitionPropertyUIHints
object
2 properties
WorkloadProfileSpecDefinitionProperty
object
8 properties 1 required
WorkloadProfileResponse
object
Workload Profiles provide the baseline configuration for Workloads in Applications in Humanitec. Developers can configure various features of a workload profil…
12 properties 11 required
WorkloadProfileSpecDefinitionPropertyType
string
WorkloadProfileSpecDefinitionRuntimeProperty
object
5 properties 1 required
WorkloadProfileVersionResponse
object
A version of a workload profile.
10 properties 10 required
WorkloadProfileChartReference
object
References a workload profile chart.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

humanitec-workloadprofile-api-openapi.yml Raw ↑

Other APIs Humanitec publishes across the network.

Humanitec AccountType API
Humanitec ActiveResource API
Humanitec Agents API
Humanitec Application API
Humanitec Artefact API
Humanitec ArtefactVersion API
Humanitec AuditLogs API
Humanitec AutomationRule API
Humanitec Delta API
Humanitec Deployment API
Humanitec DriverDefinition API
Humanitec Environment API