public
WorkloadProfile

Update a Workload Profile

put/orgs/{orgId}/workload-profiles/{profileQid}

Request

  • Base URL
    https://api.humanitec.io
  • URL
    https://api.humanitec.io/orgs/{orgId}/workload-profiles/{profileQid}
  • Auth
    none declared

Path parameters

orgIdstring required

The Organization ID

profileQidstring required

The Workload Profile ID.

Request body

descriptionstring

Describes the workload profile

deprecation_messagestring

A not-empty string indicates that the workload profile is deprecated.

versionstring

Version identifier. The version must be unique, but the API doesn't not enforce any ordering. Currently workloads will always use the latest update.

If no identifier is provided, the each update will generate a random version identifier.

Response

The resulting WorkloadProfile.

created_atstring date-time required

Creation date

created_bystring required

User created the profile

descriptionstring required

Describes the workload profile

deprecation_messagestring

A not-empty string indicates that the workload profile is deprecated.

idstring required

Workload Profile ID

org_idstring required

Organization ID

spec_schemaunknown required
updated_atstring date-time required

Timestamp when the entity was last updated.

updated_bystring required

User who last updated the entity.

versionstring required

Version identifier.

Example response

{
  "created_at": "2020-06-22T09:37:23.523Z"
}

Changes

No recorded changes to this operation across all 9 revisions of this API.