Humanitec API
Introduction
The Humanitec API allows you to automate and integrate Humanitec into your developer and operational workflows.
The API is a REST based API. It is based around a set of concepts:
- Core
- External Resources
- Sets and Deltas
Authentication
Almost all requests made to the Humanitec API require Authentication. Humanitec provides 2 ways of authenticating with the API: Bearer and JWT.
Bearer Authentication
This form of authentication makes use of a static token. It is intended to be used when machines interact with the Humanitec API. Bearer tokens should be used for very narrow purposes. This allows for the token to be revoked if it is compromised and so limit the scope of exposure.
New Bearer tokens can be obtained via the UI:
- Log into Humanitec at https://app.humanitec.io
- Go to Organization Settings
- Select API tokens
- Enter a name for the new token and click on Generate new token
The token is passed to the API via the Authorization header. Assuming the issued token is HUMANITEC_TOKEN, the request could be made as follows:
curl -H 'Authorization: Bearer HUMANITEC_TOKEN' https://api.humanitec.io/orgs/my-org/apps
JWT Authentication
This form of authentication makes use of a JSON Web Token (JWT). It is intended to be used when humans interact with the Humanitec API. JWTs expire after a period of time. This means that a new JWT will need to be generated regularly. This makes them well suited to working in short sessions, but not for automation. (See Bearer Authentication.)
The token is passed to the API via the Authorization header. Assuming the issued token is HUMANITEC_JWT, the request could be made as follows:
curl -H 'Authorization: JWT HUMANITEC_JWT' https://api.humanitec.io/orgs/my-org/apps
Content Types
All of the Humanitec API unless explicitly only accepts content types of application/json and will always return valid application/json or an empty response.
Response Codes
Success
Any response code in the 2xx range should be regarded as success.
| Code | Meaning |
| --- | --- |
| 200 | Success |
| 201 | Success (In future, 201 will be replaced by 200) |
| 204 | Success, but no content in response |
Note: We plan to simplify the interface by replacing 201 with 200 status codes.
Failure
Any response code in the 4xx should be regarded as an error which can be rectified by the client. 5xx error codes indicate errors that cannot be corrected by the client.
| Code | Meaning |
| --- | --- |
| 400 | General error. (Body will contain details) |
| 401 | Attempt to access protected resource without Authorization Header. |
| 403 | The Bearer or JWT does not grant access to the requested resource. |
| 404 | Resource not found. |
| 405 | Method not allowed |
| 409 | Conflict. Usually indicated a resource with that ID already exists. |
| 422 | Unprocessable Entity. The body was not valid JSON, was empty or contained an object different from what was expected. |
| 429 | Too many requests - request rate limit has been reached. |
| 500 | Internal Error. If it occurs repeatedly, contact support. |
Version: 0.24.1
BasePath:/
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
[ Jump to Models ]
Table of Contents
Up
get /orgs/{orgId}/resources/account-types
List Resource Account Types available to the organization. (orgsOrgIdResourcesAccountTypesGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Return type
Example data
Content-Type: application/json
[ {
"name" : "GCP",
"type" : "gcp"
}, {
"name" : "GCP",
"type" : "gcp"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty list of Resources Accounts Types.
500
Internal application error.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/envs/{envId}/resources
List Active Resources provisioned in an environment. (orgsOrgIdAppsAppIdEnvsEnvIdResourcesGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
Return type
Example data
Content-Type: application/json
[ {
"app_id" : "test-app",
"class" : "default",
"def_id" : "gcp-dev-postgres",
"deploy_id" : "172a1013b",
"env_id" : "gcp-dev",
"env_type" : "development",
"gu_res_id" : "7bd3966c9ff8eaa66c5cce855c03d715857c3440",
"org_id" : "test-org",
"res_id" : "modules.my-module.externals.my-db",
"resource" : {
"values" : {
"host" : "127.0.0.1",
"name" : "db_33c7ef9b_8d90-4c62_a1cf_0cdd30fd29a9",
"port" : 5432
}
},
"type" : "postgres",
"updated_at" : "2020-06-23T16:53:12Z"
}, {
"app_id" : "test-app",
"class" : "default",
"def_id" : "gcp-dev-postgres",
"deploy_id" : "172a1013b",
"env_id" : "gcp-dev",
"env_type" : "development",
"gu_res_id" : "7bd3966c9ff8eaa66c5cce855c03d715857c3440",
"org_id" : "test-org",
"res_id" : "modules.my-module.externals.my-db",
"resource" : {
"values" : {
"host" : "127.0.0.1",
"name" : "db_33c7ef9b_8d90-4c62_a1cf_0cdd30fd29a9",
"port" : 5432
}
},
"type" : "postgres",
"updated_at" : "2020-06-23T16:53:12Z"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty list of Active Resources.
500
Internal application error.
HumanitecErrorResponse
Up
delete /orgs/{orgId}/apps/{appId}/envs/{envId}/resources/{type}/{resId}
Delete Active Resources. (orgsOrgIdAppsAppIdEnvsEnvIdResourcesTypeResIdDelete)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
type (required)
Path Parameter — The Resource Type, may include a resource class: {type}.{class}.
resId (required)
Path Parameter — The Resource ID.
Responses
202
The resource has successfully been marked for deletion.
204
The resource deleted.
404
The requested resource could not be found.
409
Conflict when deleting resource.
Up
get /orgs/{orgId}/resources/defs/{defId}/resources
List Active Resources provisioned via a specific Resource Definition. (orgsOrgIdResourcesDefsDefIdResourcesGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
defId (required)
Path Parameter — The Resource Definition ID.
Return type
Example data
Content-Type: application/json
[ {
"app_id" : "test-app",
"class" : "default",
"def_id" : "gcp-dev-postgres",
"deploy_id" : "172a1013b",
"env_id" : "gcp-dev",
"env_type" : "development",
"gu_res_id" : "7bd3966c9ff8eaa66c5cce855c03d715857c3440",
"org_id" : "test-org",
"res_id" : "modules.my-module.externals.my-db",
"resource" : {
"values" : {
"host" : "127.0.0.1",
"name" : "db_33c7ef9b_8d90-4c62_a1cf_0cdd30fd29a9",
"port" : 5432
}
},
"type" : "postgres",
"updated_at" : "2020-06-23T16:53:12Z"
}, {
"app_id" : "test-app",
"class" : "default",
"def_id" : "gcp-dev-postgres",
"deploy_id" : "172a1013b",
"env_id" : "gcp-dev",
"env_type" : "development",
"gu_res_id" : "7bd3966c9ff8eaa66c5cce855c03d715857c3440",
"org_id" : "test-org",
"res_id" : "modules.my-module.externals.my-db",
"resource" : {
"values" : {
"host" : "127.0.0.1",
"name" : "db_33c7ef9b_8d90-4c62_a1cf_0cdd30fd29a9",
"port" : 5432
}
},
"type" : "postgres",
"updated_at" : "2020-06-23T16:53:12Z"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty list of Active Resources.
500
Internal application error.
HumanitecErrorResponse
Up
delete /orgs/{orgId}/apps/{appId}
Delete an Application (orgsOrgIdAppsAppIdDelete)
Deleting an Application will also delete everything associated with it. This includes Environments, Deployment history on those Environments, and any shared values and secrets associated.
Deletions are currently irreversible.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Application Successfully deleted.
401
The Authorization header was not present or invalid.
HumanitecErrorResponse
404
No Application with <code>id</code> in Organization.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}
Get an existing Application (orgsOrgIdAppsAppIdGet)
Gets a specific Application in the specified Organization by ID.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-05-22T14:53:27Z",
"created_by" : "a.user@example.com",
"envs" : [ {
"id" : "my-env",
"name" : "My Environment"
} ],
"id" : "my-app",
"name" : "My Application"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The Application requested.
ApplicationResponse
Example data
Content-Type: application/json
{"created_at":"2020-06-15T09:32:03Z","created_by":"a-user@example.com","envs":{"id":"development","name":"Development","type":"development"},"id":"my-app","name":"My Awesome App"}
404
No Application with ID <code>appId</code> in Organization.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps
List all Applications in an Organization. (orgsOrgIdAppsGet)
Listing or lists of all Applications that exist within a specific Organization.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Return type
Example data
Content-Type: application/json
[ {
"created_at" : "2020-05-22T14:53:27Z",
"created_by" : "a.user@example.com",
"envs" : [ {
"id" : "my-env",
"name" : "My Environment"
} ],
"id" : "my-app",
"name" : "My Application"
}, {
"created_at" : "2020-05-22T14:53:27Z",
"created_by" : "a.user@example.com",
"envs" : [ {
"id" : "my-env",
"name" : "My Environment"
} ],
"id" : "my-app",
"name" : "My Application"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Possibly empty list of Applications.
Example data
Content-Type: application/json
[{"created_at":"2020-06-15T09:32:03Z","created_by":"a-user@example.com","envs":{"id":"development","name":"Development","type":"development"},"id":"my-app","name":"My Awesome App"}]
Up
post /orgs/{orgId}/apps
Add a new Application to an Organization (orgsOrgIdAppsPost)
Creates a new Application, then adds it to the specified Organization.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The request ID, Human-friendly name and environment of the Application.
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-05-22T14:53:27Z",
"created_by" : "a.user@example.com",
"envs" : [ {
"id" : "my-env",
"name" : "My Environment"
} ],
"id" : "my-app",
"name" : "My Application"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
The Application requested.
ApplicationResponse
Example data
Content-Type: application/json
{"created_at":"2020-06-15T09:32:03Z","created_by":"a-user@example.com","envs":{"id":"development","name":"Development","type":"development"},"id":"my-app","name":"My Awesome App"}
400
The request body was unparseable.
HumanitecErrorResponse
401
The Authorization header was not present or invalid.
HumanitecErrorResponse
409
The supplied <code>id</code> clashes with an existing Application.
HumanitecErrorResponse
Up
delete /orgs/{orgId}/artefacts/{artefactId}
Delete Artefact and all related Artefact Versions (orgsOrgIdArtefactsArtefactIdDelete)
The specified Artefact and its Artefact Versions will be permanently deleted. Only Administrators can delete an Artefact.
Path parameters
orgId (required)
Path Parameter — The organization ID.
artefactId (required)
Path Parameter — The Artefact ID.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Artefact and related Artefact Versions successfully deleted.
403
Request forbidden. This action can only be performed by users holding the Administrator role. It is not possible to delete a built-in artefact.
HumanitecErrorResponse
404
Artefact not found within your organization.
HumanitecErrorResponse
Up
get /orgs/{orgId}/artefacts
List all Artefacts. (orgsOrgIdArtefactsGet)
Returns the Artefacts registered with your organization. If no elements are found, an empty list is returned.
Path parameters
orgId (required)
Path Parameter — The organization ID.
Query parameters
type (optional)
Query Parameter — (Optional) Filter Artefacts by type.
name (optional)
Query Parameter — (Optional) Filter Artefacts by name.
Return type
Example data
Content-Type: application/json
[ {
"created_at" : "2020-05-12T16:12:13Z",
"created_by" : "123456789",
"id" : "123e4567-e89b-12d3-a456-426614174000",
"name" : "registry.humanitec.io/my-org/my-service",
"type" : "container",
"updated_at" : "2020-06-12T16:12:13Z",
"updated_by" : "987654321"
}, {
"created_at" : "2020-05-12T16:12:13Z",
"created_by" : "123456789",
"id" : "123e4567-e89b-12d3-a456-426614174000",
"name" : "registry.humanitec.io/my-org/my-service",
"type" : "container",
"updated_at" : "2020-06-12T16:12:13Z",
"updated_by" : "987654321"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The list of Artefacts within the organization.
Example data
Content-Type: application/json
[{"created_at":"2020-06-10T10:00:00Z","created_by":"1234567789","id":"662b80db-cc71-40cf-b601-08d57983f6e4","name":"registry.humanitec.io/public/sample-app","type":"container","updated_at":"2020-06-12T10:00:00Z","updated_by":"987654321"},{"created_at":"2020-06-10T10:00:00Z","created_by":"1234567789","id":"abf214a0-5de0-430d-a0b4-bb9871567ade","name":"registry.humanitec.io/public/sample-service","type":"container","updated_at":"2020-06-12T10:00:00Z","updated_by":"987654321"}]
Up
get /orgs/{orgId}/artefact-versions/{artefactVersionId}
Get an Artefacts Versions. (orgsOrgIdArtefactVersionsArtefactVersionIdGet)
Returns a specific Artefact Version.
Path parameters
orgId (required)
Path Parameter — The organization ID.
artefactVersionId (required)
Path Parameter — The Artefact Version ID.
Return type
Example data
Content-Type: application/json
{
"archived" : false,
"artefact_id" : "123e4567-e89b-12d3-a456-426614174000",
"commit" : "060c3d6530a881afb808f105f36af25e1ad1b2f3",
"created_at" : "2020-05-25T17:41:57Z",
"created_by" : "987654321",
"digest" : "sha256:8414aa82208bc4c2761dc149df67e25c6b8a9380e5d8c4e7b5c84ca2d04bb244",
"id" : "b4c9e4e2-b3e5-11ec-b909-0242ac120002",
"name" : "registry.humanitec.io/my-org/my-service",
"ref" : "refs/heads/main",
"updated_at" : "2020-06-25T17:41:57Z",
"updated_by" : "123456789",
"version" : "1.2.6"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
An Artefact Version.
ArtefactVersionResponse
Example data
Content-Type: application/json
{"archived":false,"artefact_id":"da97af75-2e7c-4ef3-bec0-755ce1e8dd29","commit":"a5cf4ab4b8a958005202916bf3bb627ebd62a11f","created_at":"2020-06-10T10:00:00Z","created_by":"1234567789","digest":"sha256:8414aa82208bc4c2761dc149df67e25c6b8a9380e5d8c4e7b5c84ca2d04bb244","id":"662b80db-cc71-40cf-b601-08d57983f6e4","name":"registry.humanitec.io/public/sample-app","ref":"refs/heads/master","updated_at":"2020-06-12T10:00:00Z","updated_by":"987654321","version":"1.3.0"}
400
Malformed Artefact Version ID.
HumanitecErrorResponse
404
Artefact Version not found.
HumanitecErrorResponse
Up
get /orgs/{orgId}/artefact-versions
List all Artefacts Versions. (orgsOrgIdArtefactVersionsGet)
Returns the Artefact Versions registered with your organization. If no elements are found, an empty list is returned.
Path parameters
orgId (required)
Path Parameter — The organization ID.
Query parameters
name (optional)
Query Parameter — (Optional) Filter Artefact Versions by name.
reference (optional)
Query Parameter — (Optional) Filter Artefact Versions by the reference to a Version of the same Artefact. This cannot be used together with <code>name</code>.
archived (optional)
Query Parameter — (Optional) Filter for non-archived Artefact Versions. If no filter is defined only non-archived Artefact Versions are returned, if the filter is true both archived and non-archived Versions are returned.
Return type
Example data
Content-Type: application/json
[ {
"archived" : false,
"artefact_id" : "123e4567-e89b-12d3-a456-426614174000",
"commit" : "060c3d6530a881afb808f105f36af25e1ad1b2f3",
"created_at" : "2020-05-25T17:41:57Z",
"created_by" : "987654321",
"digest" : "sha256:8414aa82208bc4c2761dc149df67e25c6b8a9380e5d8c4e7b5c84ca2d04bb244",
"id" : "b4c9e4e2-b3e5-11ec-b909-0242ac120002",
"name" : "registry.humanitec.io/my-org/my-service",
"ref" : "refs/heads/main",
"updated_at" : "2020-06-25T17:41:57Z",
"updated_by" : "123456789",
"version" : "1.2.6"
}, {
"archived" : false,
"artefact_id" : "123e4567-e89b-12d3-a456-426614174000",
"commit" : "060c3d6530a881afb808f105f36af25e1ad1b2f3",
"created_at" : "2020-05-25T17:41:57Z",
"created_by" : "987654321",
"digest" : "sha256:8414aa82208bc4c2761dc149df67e25c6b8a9380e5d8c4e7b5c84ca2d04bb244",
"id" : "b4c9e4e2-b3e5-11ec-b909-0242ac120002",
"name" : "registry.humanitec.io/my-org/my-service",
"ref" : "refs/heads/main",
"updated_at" : "2020-06-25T17:41:57Z",
"updated_by" : "123456789",
"version" : "1.2.6"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A list of Artefact Versions registered with your organization.
Example data
Content-Type: application/json
[{"archived":false,"artefact_id":"da97af75-2e7c-4ef3-bec0-755ce1e8dd29","commit":"a5cf4ab4b8a958005202916bf3bb627ebd62a11f","created_at":"2020-06-10T10:00:00Z","created_by":"1234567789","digest":"sha256:8414aa82208bc4c2761dc149df67e25c6b8a9380e5d8c4e7b5c84ca2d04bb244","id":"662b80db-cc71-40cf-b601-08d57983f6e4","name":"registry.humanitec.io/public/sample-app","ref":"refs/heads/master","updated_at":"2020-06-12T10:00:00Z","updated_by":"987654321","version":"1.3.0"},{"archived":false,"artefact_id":"8a76aff7-cc3d-4d06-994d-4825bce80529","commit":"a5cf4ab4b8a958005202916bf3bb627ebd62a11f","created_at":"2020-06-10T10:00:00Z","created_by":"1234567789","digest":"","id":"abf214a0-5de0-430d-a0b4-bb9871567ade","name":"registry.humanitec.io/public/sample-service","ref":"refs/heads/master","updated_at":"2020-06-13T10:00:00Z","updated_by":"987654321","version":"1.2.0"}]
400
Bad request.
HumanitecErrorResponse
Up
post /orgs/{orgId}/artefact-versions
Register a new Artefact Version with your organization. (orgsOrgIdArtefactVersionsPost)
Path parameters
orgId (required)
Path Parameter — The organization ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The data needed to register a new Artefact Version within the organization.
Query parameters
vcs (optional)
Query Parameter — (Optional) Which version control system the version comes from. Default value is "git". If this parameter is not supplied or its value is "git", the provided ref, if not empty, is checked to ensure that it has the prefix "refs/".
Return type
Example data
Content-Type: application/json
{
"archived" : false,
"artefact_id" : "123e4567-e89b-12d3-a456-426614174000",
"commit" : "060c3d6530a881afb808f105f36af25e1ad1b2f3",
"created_at" : "2020-05-25T17:41:57Z",
"created_by" : "987654321",
"digest" : "sha256:8414aa82208bc4c2761dc149df67e25c6b8a9380e5d8c4e7b5c84ca2d04bb244",
"id" : "b4c9e4e2-b3e5-11ec-b909-0242ac120002",
"name" : "registry.humanitec.io/my-org/my-service",
"ref" : "refs/heads/main",
"updated_at" : "2020-06-25T17:41:57Z",
"updated_by" : "123456789",
"version" : "1.2.6"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
An Artefact Version.
ArtefactVersionResponse
400
Either one or more request body parameters are missing or invalid, or the requested payload is not provided or malformed.
HumanitecErrorResponse
401
Request unauthorised.
HumanitecErrorResponse
Up
get /orgs/{orgId}/artefacts/{artefactId}/versions
List all Artefact Versions of an Artefact. (orgsOrgIdArtefactsArtefactIdVersionsGet)
Returns the Artefact Versions of a specified Artefact registered with your organization. If no elements are found, an empty list is returned.
Path parameters
orgId (required)
Path Parameter — The organization ID.
artefactId (required)
Path Parameter — The Artefact ID.
Query parameters
archived (optional)
Query Parameter — (Optional) Filter for non-archived Artefact Versions. If no filter is defined only non-archived Artefact Versions are returned, if the filter is true both archived and non-archived Versions are returned.
reference (optional)
Query Parameter — (Optional) Filter Artefact Versions by by name including a version or digest.
limit (optional)
Query Parameter — (Optional) Limit the number of versions returned by the endpoint.
Return type
Example data
Content-Type: application/json
[ {
"archived" : false,
"artefact_id" : "123e4567-e89b-12d3-a456-426614174000",
"commit" : "060c3d6530a881afb808f105f36af25e1ad1b2f3",
"created_at" : "2020-05-25T17:41:57Z",
"created_by" : "987654321",
"digest" : "sha256:8414aa82208bc4c2761dc149df67e25c6b8a9380e5d8c4e7b5c84ca2d04bb244",
"id" : "b4c9e4e2-b3e5-11ec-b909-0242ac120002",
"name" : "registry.humanitec.io/my-org/my-service",
"ref" : "refs/heads/main",
"updated_at" : "2020-06-25T17:41:57Z",
"updated_by" : "123456789",
"version" : "1.2.6"
}, {
"archived" : false,
"artefact_id" : "123e4567-e89b-12d3-a456-426614174000",
"commit" : "060c3d6530a881afb808f105f36af25e1ad1b2f3",
"created_at" : "2020-05-25T17:41:57Z",
"created_by" : "987654321",
"digest" : "sha256:8414aa82208bc4c2761dc149df67e25c6b8a9380e5d8c4e7b5c84ca2d04bb244",
"id" : "b4c9e4e2-b3e5-11ec-b909-0242ac120002",
"name" : "registry.humanitec.io/my-org/my-service",
"ref" : "refs/heads/main",
"updated_at" : "2020-06-25T17:41:57Z",
"updated_by" : "123456789",
"version" : "1.2.6"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Returns all Versions of the specified Artefact.
Example data
Content-Type: application/json
[{"archived":false,"artefact_id":"da97af75-2e7c-4ef3-bec0-755ce1e8dd29","commit":"a5cf4ab4b8a958005202916bf3bb627ebd62a11f","created_at":"2020-06-10T10:00:00Z","created_by":"1234567789","digest":"sha256:8414aa82208bc4c2761dc149df67e25c6b8a9380e5d8c4e7b5c84ca2d04bb244","id":"662b80db-cc71-40cf-b601-08d57983f6e4","name":"registry.humanitec.io/public/sample-app","ref":"refs/heads/master","updated_at":"2020-06-12T10:00:00Z","updated_by":"987654321","version":"1.3.0"},{"archived":false,"artefact_id":"da97af75-2e7c-4ef3-bec0-755ce1e8dd29","commit":"a5cf4ab4b8a958005202916bf3bb627ebd62a11f","created_at":"2020-06-10T10:00:00Z","created_by":"1234567789","digest":"","id":"abf214a0-5de0-430d-a0b4-bb9871567ade","name":"registry.humanitec.io/public/sample-app","ref":"refs/heads/master","updated_at":"2020-06-13T10:00:00Z","updated_by":"987654321","version":"1.2.0"}]
400
Invalid inputs provided.
HumanitecErrorResponse
404
No Artefact with the supplied ID <code>artefactID</code> has been found within the organization.
HumanitecErrorResponse
Up
patch /orgs/{orgId}/artefacts/{artefactId}/versions/{versionId}
Update Version of an Artefact. (orgsOrgIdArtefactsArtefactIdVersionsVersionIdPatch)
Update the version of a specified Artefact registered with your organization".
Path parameters
orgId (required)
Path Parameter — The organization ID.
artefactId (required)
Path Parameter — The Artefact ID.
versionId (required)
Path Parameter — The Version ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The Artefact Version Update Request. Only the field <code>archive</code> can be updated.
Return type
Example data
Content-Type: application/json
{
"archived" : false,
"artefact_id" : "123e4567-e89b-12d3-a456-426614174000",
"commit" : "060c3d6530a881afb808f105f36af25e1ad1b2f3",
"created_at" : "2020-05-25T17:41:57Z",
"created_by" : "987654321",
"digest" : "sha256:8414aa82208bc4c2761dc149df67e25c6b8a9380e5d8c4e7b5c84ca2d04bb244",
"id" : "b4c9e4e2-b3e5-11ec-b909-0242ac120002",
"name" : "registry.humanitec.io/my-org/my-service",
"ref" : "refs/heads/main",
"updated_at" : "2020-06-25T17:41:57Z",
"updated_by" : "123456789",
"version" : "1.2.6"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The updated Artefact Version.
ArtefactVersionResponse
400
One or more request parameters are missing or invalid, or the requested payload is not provided or malformed.
HumanitecErrorResponse
401
Request unauthorised.
HumanitecErrorResponse
403
Update requested on a version of a builtin artefact.
HumanitecErrorResponse
404
No Artefact with the supplied artefactId or no Artefact Version with the supplied versionId have been found within the organization.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/envs/{envId}/rules
List all Automation Rules in an Environment. (orgsOrgIdAppsAppIdEnvsEnvIdRulesGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
Return type
Example data
Content-Type: application/json
[ {
"active" : true,
"artefacts_filter" : [ "http://registry.org/sample-service" ],
"created_at" : "2021-07-22T14:53:27Z",
"created_by" : "0dbbdc88-b125-47f1-9a96-6c4c9d6ddc70",
"exclude_artefacts_filter" : false,
"exclude_images_filter" : false,
"id" : "923486d012f20324",
"images_filter" : [ "sample-service" ],
"match" : "^pr-[0-9]+-.*$",
"match_ref" : "^refs/heads/pr-[0-9]+-.*$",
"type" : "update",
"update_to" : "branch"
}, {
"active" : true,
"artefacts_filter" : [ "http://registry.org/sample-service" ],
"created_at" : "2021-07-22T14:53:27Z",
"created_by" : "0dbbdc88-b125-47f1-9a96-6c4c9d6ddc70",
"exclude_artefacts_filter" : false,
"exclude_images_filter" : false,
"id" : "923486d012f20324",
"images_filter" : [ "sample-service" ],
"match" : "^pr-[0-9]+-.*$",
"match_ref" : "^refs/heads/pr-[0-9]+-.*$",
"type" : "update",
"update_to" : "branch"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty array of Automation Rules
Example data
Content-Type: application/json
[{"active":true,"artefacts_filter":["http://registry.org/sample-service"],"created_at":"2021-07-22T14:53:27Z","created_by":"0dbbdc88-b125-47f1-9a96-6c4c9d6ddc70","exclude_artefacts_filter":false,"exclude_images_filter":false,"id":"923486d012f20324","images_filter":["sample-service"],"match":"^pr-[0-9]+-.*$","match_ref":"^refs/heads/pr-[0-9]+-.*$","type":"update","update_to":"branch"}]
500
Internal Server error.
Up
post /orgs/{orgId}/apps/{appId}/envs/{envId}/rules
Create a new Automation Rule for an Environment. (orgsOrgIdAppsAppIdEnvsEnvIdRulesPost)
Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if images_filter (deprecated) and artefacts_filter are used in the same payload. The same is true for exclude_images_filter (deprecated) and exclude_artefacts_filter. match and update_to are still supported but will trigger an error if combined with match_ref.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The definition of the Automation Rule.
example: {
"active" : true,
"artefacts_filter" : [ "http://registry.org/sample-service" ],
"exclude_artefacts_filter" : false,
"match_ref" : "^refs/heads/pr-[0-9]+-.*$",
"type" : "update"
}
Return type
Example data
Content-Type: application/json
{
"active" : true,
"artefacts_filter" : [ "http://registry.org/sample-service" ],
"created_at" : "2021-07-22T14:53:27Z",
"created_by" : "0dbbdc88-b125-47f1-9a96-6c4c9d6ddc70",
"exclude_artefacts_filter" : false,
"exclude_images_filter" : false,
"id" : "923486d012f20324",
"images_filter" : [ "sample-service" ],
"match" : "^pr-[0-9]+-.*$",
"match_ref" : "^refs/heads/pr-[0-9]+-.*$",
"type" : "update",
"update_to" : "branch"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
The AutomationRule
AutomationRuleResponse
400
The input was not a valid Automation Rule.
ErrorInfoResponse
422
The request body could not be processed.
Up
delete /orgs/{orgId}/apps/{appId}/envs/{envId}/rules/{ruleId}
Delete Automation Rule from an Environment. (orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
ruleId (required)
Path Parameter — The Automation Rule ID.
Responses
204
The AutomationRule was deleted.
404
There is no automation rule with the supplied ID.
Up
get /orgs/{orgId}/apps/{appId}/envs/{envId}/rules/{ruleId}
Get a specific Automation Rule for an Environment. (orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
ruleId (required)
Path Parameter — The Automation Rule ID.
Return type
Example data
Content-Type: application/json
{
"active" : true,
"artefacts_filter" : [ "http://registry.org/sample-service" ],
"created_at" : "2021-07-22T14:53:27Z",
"created_by" : "0dbbdc88-b125-47f1-9a96-6c4c9d6ddc70",
"exclude_artefacts_filter" : false,
"exclude_images_filter" : false,
"id" : "923486d012f20324",
"images_filter" : [ "sample-service" ],
"match" : "^pr-[0-9]+-.*$",
"match_ref" : "^refs/heads/pr-[0-9]+-.*$",
"type" : "update",
"update_to" : "branch"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The AutomationRule
AutomationRuleResponse
Example data
Content-Type: application/json
{"active":true,"artefacts_filter":["http://registry.org/sample-service"],"created_at":"2021-07-22T14:53:27Z","created_by":"0dbbdc88-b125-47f1-9a96-6c4c9d6ddc70","exclude_artefacts_filter":false,"exclude_images_filter":false,"id":"923486d012f20324","images_filter":["sample-service"],"match":"^pr-[0-9]+-.*$","match_ref":"^refs/heads/pr-[0-9]+-.*$","type":"update","update_to":"branch"}
404
There is no automation rule with the supplied ID.
Up
put /orgs/{orgId}/apps/{appId}/envs/{envId}/rules/{ruleId}
Update an existing Automation Rule for an Environment. (orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut)
Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if images_filter (deprecated) and artefacts_filter are used in the same payload. The same is true for exclude_images_filter (deprecated) and exclude_artefacts_filter. match and update_to are still supported but will trigger an error if combined with match_ref.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
ruleId (required)
Path Parameter — The Automation Rule ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The definition of the Automation Rule.
example: {
"active" : true,
"artefacts_filter" : [ "http://registry.org/sample-service" ],
"exclude_artefacts_filter" : false,
"match_ref" : "^refs/heads/pr-[0-9]+-.*$",
"type" : "update"
}
Return type
Example data
Content-Type: application/json
{
"active" : true,
"artefacts_filter" : [ "http://registry.org/sample-service" ],
"created_at" : "2021-07-22T14:53:27Z",
"created_by" : "0dbbdc88-b125-47f1-9a96-6c4c9d6ddc70",
"exclude_artefacts_filter" : false,
"exclude_images_filter" : false,
"id" : "923486d012f20324",
"images_filter" : [ "sample-service" ],
"match" : "^pr-[0-9]+-.*$",
"match_ref" : "^refs/heads/pr-[0-9]+-.*$",
"type" : "update",
"update_to" : "branch"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The AutomationRule
AutomationRuleResponse
400
The input was not a valid Automation Rule.
ErrorInfoResponse
404
There is no automation rule with the supplied ID.
422
The request body could not be processed.
Up
get /orgs/{orgId}/apps/{appId}/deltas/{deltaId}
Fetch an existing Delta (getDelta)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
deltaId (required)
Path Parameter — ID of the Delta to fetch.
Return type
Example data
Content-Type: application/json
{
"id" : "49393b5004d072000b8abfd910c61685eb9235f5",
"metadata" : { },
"modules" : {
"add" : {
"redis-cache" : {
"profile" : "humanitec/redis"
}
},
"remove" : [ "simple-service" ],
"update" : {
"module-one" : [ {
"op" : "replace",
"path" : "/spec/containers/core-service/variables/EXAMPLE",
"value" : "New Value"
} ]
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The requested Deployment Delta.
DeltaResponse
404
No Deployment Delta with ID <code>deltaId</code> found in Application.
String
Up
put /orgs/{orgId}/apps/{appId}/deltas/{deltaId}/metadata/archived
Mark a Delta as "archived" (orgsOrgIdAppsAppIdDeltasDeltaIdMetadataArchivedPut)
Archived Deltas are still accessible but can no longer be updated.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
deltaId (required)
Path Parameter — ID of the Deployment Delta.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Either <code>true</code> or <code>false</code>.
example: true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Archived state successfully updated.
400
The request was invalid.
HumanitecErrorResponse
404
No Deployment Delta with ID <code>deltaId</code> found in Application.
String
Up
put /orgs/{orgId}/apps/{appId}/deltas/{deltaId}/metadata/env_id
Change the Environment of a Delta (orgsOrgIdAppsAppIdDeltasDeltaIdMetadataEnvIdPut)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
deltaId (required)
Path Parameter — ID of the Deployment Delta.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The new Environment ID. (NOTE: The string must still be JSON encoded.)
example: "new-env"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Environment ID successfully updated.
400
The request was invalid.
HumanitecErrorResponse
404
No Deployment Delta with ID <code>deltaId</code> found in Application.
String
Up
put /orgs/{orgId}/apps/{appId}/deltas/{deltaId}/metadata/name
Change the name of a Delta (orgsOrgIdAppsAppIdDeltasDeltaIdMetadataNamePut)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
deltaId (required)
Path Parameter — ID of the Deployment Delta.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The new name.(NOTE: The string must still be JSON encoded.)
example: "Update for ticket #s 2568 & 2572"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Name successfully updated.
400
The request was invalid.
HumanitecErrorResponse
404
No Deployment Delta with ID <code>deltaId</code> found in Application.
String
Up
patch /orgs/{orgId}/apps/{appId}/deltas/{deltaId}
Update an existing Delta (orgsOrgIdAppsAppIdDeltasDeltaIdPatch)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
deltaId (required)
Path Parameter — ID of the Delta to update.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — <p>An array of Deltas.</p>
<p>The Deltas in the request are combined, meaning the current Delta is updated in turn by each Delta in the request. Once all Deltas have been combined, the resulting Delta is simplified.</p>
<ul>
<li>
<p>All Modules in the <code>modules.add</code> property are replaced with the new Delta's values. If the value of a Module is <code>null</code>, and the ID is in the <code>modules.remove</code> list, it is removed from the <code>modules.remove</code> list.</p>
</li>
<li>
<p>All IDs listed in <code>modules.remove</code> are combined. Any ID in <code>modules.remove</code> and also in <code>modules.add</code> are removed from <code>modules.add</code></p>
</li>
<li>
<p>The lists of JSON Patches in <code>modules.update</code> are concatenated or created in <code>modules.updates</code>.</p>
</li>
</ul>
<p>Simplification involves:</p>
<ul>
<li>
<p>Applying any entries in <code>modules.updates</code> that have matching IDs in <code>modules.add</code> to the <code>modules.add</code> entry and removing the <code>modules.update</code> entry.</p>
</li>
<li>
<p>Reducing the number of JSON Patches in each <code>modules.update</code> entry to the smallest set that has the same effect.</p>
</li>
</ul>
<p><strong>Extension to JSON Patch</strong></p>
<p>If a JSON Patch entry needs to be removed, without side effects, the <code>value</code> of the <code>remove</code> action can be set to `{"scope": "delta"}. This will result in the remove action being used during simplification but be discarded before the Delta is finalized.</p>
<p>If the user making the request is not the user who created the Delta and they are not already on the contributors list, they will be added to the contributors list.</p>
<p><em>NOTE: If the <code>id</code> or <code>metadata</code> properties are specified, they will be ignored.</em></p>
example: [ {
"modules" : {
"updates" : {
"module-one" : [ {
"op" : "add",
"path" : "/spec/containers/simple-service/variables/REDIS_URL",
"value" : "redis://${modules.redis-cache.service.name}"
} ]
}
}
} ]
Return type
Example data
Content-Type: application/json
{
"id" : "49393b5004d072000b8abfd910c61685eb9235f5",
"metadata" : { },
"modules" : {
"add" : {
"redis-cache" : {
"profile" : "humanitec/redis"
}
},
"remove" : [ "simple-service" ],
"update" : {
"module-one" : [ {
"op" : "replace",
"path" : "/spec/containers/core-service/variables/EXAMPLE",
"value" : "New Value"
} ]
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The requested Deployment Delta.
DeltaResponse
400
The request was invalid.
HumanitecErrorResponse
404
No Deployment Delta with ID <code>deltaId</code> found in Application.
String
Up
get /orgs/{orgId}/apps/{appId}/deltas
List Deltas in an Application (orgsOrgIdAppsAppIdDeltasGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Query parameters
archived (optional)
Query Parameter — If true, return archived Deltas.
env (optional)
Query Parameter — Only return Deltas associated with the specified Environment.
Return type
Example data
Content-Type: application/json
[ {
"id" : "49393b5004d072000b8abfd910c61685eb9235f5",
"metadata" : { },
"modules" : {
"add" : {
"redis-cache" : {
"profile" : "humanitec/redis"
}
},
"remove" : [ "simple-service" ],
"update" : {
"module-one" : [ {
"op" : "replace",
"path" : "/spec/containers/core-service/variables/EXAMPLE",
"value" : "New Value"
} ]
}
}
}, {
"id" : "49393b5004d072000b8abfd910c61685eb9235f5",
"metadata" : { },
"modules" : {
"add" : {
"redis-cache" : {
"profile" : "humanitec/redis"
}
},
"remove" : [ "simple-service" ],
"update" : {
"module-one" : [ {
"op" : "replace",
"path" : "/spec/containers/core-service/variables/EXAMPLE",
"value" : "New Value"
} ]
}
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty list of Deployment Deltas.
Up
post /orgs/{orgId}/apps/{appId}/deltas
Create a new Delta (orgsOrgIdAppsAppIdDeltasPost)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — <p>A Deployment Delta to create.</p>
<p>The Deployment Delta will be added with the provided content of <code>modules</code> and the 'env_id' and 'name' properties of the 'metadata' property.</p>
<p>NOTE: If the <code>id</code> property is specified, it will be ignored. A new ID will be generated and returned in the response.</p>
example: {
"metadata" : {
"env_id" : "feature-test",
"name" : "Updates for ticket # 2581"
},
"modules" : {
"updates" : {
"module-one" : [ {
"op" : "add",
"path" : "/spec/containers/simple-service/variables/REDIS_URL",
"value" : "redis://${modules.redis-cache.service.name}"
} ]
}
}
}
Return type
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The requested Deployment Delta.
inline_response_200
400
The request was invalid.
HumanitecErrorResponse
Up
put /orgs/{orgId}/apps/{appId}/deltas/{deltaId}
Update an existing Delta (putDelta)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
deltaId (required)
Path Parameter — ID of the Delta to update.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — <p>An array of Deltas.</p>
<p>The Deltas in the request are combined, meaning the current Delta is updated in turn by each Delta in the request. Once all Deltas have been combined, the resulting Delta is simplified.</p>
<ul>
<li>
<p>All Modules in the <code>modules.add</code> property are replaced with the new Delta's values. If the value of a Module is <code>null</code>, and the ID is in the <code>modules.remove</code> list, it is removed from the <code>modules.remove</code> list.</p>
</li>
<li>
<p>All IDs listed in <code>modules.remove</code> are combined. Any ID in <code>modules.remove</code> and also in <code>modules.add</code> are removed from <code>modules.add</code></p>
</li>
<li>
<p>The lists of JSON Patches in <code>modules.update</code> are concatenated or created in <code>modules.updates</code>.</p>
</li>
</ul>
<p>Simplification involves:</p>
<ul>
<li>
<p>Applying any entries in <code>modules.updates</code> that have matching IDs in <code>modules.add</code> to the <code>modules.add</code> entry and removing the <code>modules.update</code> entry.</p>
</li>
<li>
<p>Reducing the number of JSON Patches in each <code>modules.update</code> entry to the smallest set that has the same effect.</p>
</li>
</ul>
<p><strong>Extension to JSON Patch</strong></p>
<p>If a JSON Patch entry needs to be removed, without side effects, the <code>value</code> of the <code>remove</code> action can be set to `{"scope": "delta"}. This will result in the remove action being used during simplification but be discarded before the Delta is finalized.</p>
<p>If the user making the request is not the user who created the Delta and they are not already on the contributors list, they will be added to the contributors list.</p>
<p><em>NOTE: If the <code>id</code> or <code>metadata</code> properties are specified, they will be ignored.</em></p>
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
The requested Deployment Delta.
400
The request was invalid.
HumanitecErrorResponse
404
No Deployment Delta with ID <code>deltaId</code> found in Application.
String
Up
get /orgs/{orgId}/apps/{appId}/envs/{envId}/deploys/{deployId}/errors
List errors that occurred in a Deployment. (orgsOrgIdAppsAppIdEnvsEnvIdDeploysDeployIdErrorsGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
deployId (required)
Path Parameter — The Deployment ID.
Return type
Example data
Content-Type: application/json
[ {
"code" : "CLD-001",
"message" : "Incorrect cloud provider credentials.",
"object_id" : "my-workload",
"scope" : "workload",
"summary" : "Provider error"
}, {
"code" : "CLD-001",
"message" : "Incorrect cloud provider credentials.",
"object_id" : "my-workload",
"scope" : "workload",
"summary" : "Provider error"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A List of deployment errors, could be empty.
Example data
Content-Type: application/json
[{"code":"CLD-001","message":"Incorrect credentials","object_id":"my-service","scope":"workload"}]
Up
get /orgs/{orgId}/apps/{appId}/envs/{envId}/deploys/{deployId}
Get a specific Deployment. (orgsOrgIdAppsAppIdEnvsEnvIdDeploysDeployIdGet)
Gets a specific Deployment in an Application and an Environment.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
deployId (required)
Path Parameter — The Deployment ID.
Return type
Example data
Content-Type: application/json
{
"comment" : "Updated version of module-one to v0.3.1",
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "a.user@example.com",
"delta_id" : "df1ad41807b0390a9b0eaf8688e1f5baece9d764",
"env_id" : "my-env",
"from_id" : "42d4b302fd3c",
"id" : "67f1619a57d",
"status" : "in progress",
"status_changed_at" : "2020-05-22T14:59:01Z"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The Deployment requested.
DeploymentResponse
Example data
Content-Type: application/json
{}
404
No Deployment with <code>deployId</code> in Application and Environment.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/envs/{envId}/deploys
List Deployments in an Environment. (orgsOrgIdAppsAppIdEnvsEnvIdDeploysGet)
List all of the Deployments that have been carried out in the current Environment. Deployments are returned with the newest first.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
Return type
Example data
Content-Type: application/json
[ {
"comment" : "Updated version of module-one to v0.3.1",
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "a.user@example.com",
"delta_id" : "df1ad41807b0390a9b0eaf8688e1f5baece9d764",
"env_id" : "my-env",
"from_id" : "42d4b302fd3c",
"id" : "67f1619a57d",
"status" : "in progress",
"status_changed_at" : "2020-05-22T14:59:01Z"
}, {
"comment" : "Updated version of module-one to v0.3.1",
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "a.user@example.com",
"delta_id" : "df1ad41807b0390a9b0eaf8688e1f5baece9d764",
"env_id" : "my-env",
"from_id" : "42d4b302fd3c",
"id" : "67f1619a57d",
"status" : "in progress",
"status_changed_at" : "2020-05-22T14:59:01Z"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty list of Deployments.
Example data
Content-Type: application/json
[{}]
404
No Environment with <code>id</code> in Application.
HumanitecErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/envs/{envId}/deploys
Start a new Deployment. (orgsOrgIdAppsAppIdEnvsEnvIdDeploysPost)
At Humanitec, Deployments are defined as changes to the state of the Environment. The state can be changed by defining a set of desired changes to the current state via a Deployment Delta or by resetting the current state after a previous Deployment. (See Environment Rebase.) Both types of changes can be combined into a single Deployment during which the Delta is applied to the Rebased state.
When specifying a Delta, a Delta ID must be used. That Delta must have been committed to the Delta store prior to the Deployment.
A Set ID can also be defined in the deployment to force the state of the environment to a particular state. This will be ignored if the Delta is specified.
NOTE:
Directly setting a set_id in a deployment is not recommended as it will not record history of where the set came from. If the intention is to replicate an existing environment, use the environment rebasing approach described above.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The Delta describing the change to the Environment and a comment.
example: {
"comment" : "Updated version of module-one to v0.3.1",
"delta_id" : "df1ad41807b0390a9b0eaf8688e1f5baece9d764"
}
Return type
Example data
Content-Type: application/json
{
"comment" : "Updated version of module-one to v0.3.1",
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "a.user@example.com",
"delta_id" : "df1ad41807b0390a9b0eaf8688e1f5baece9d764",
"env_id" : "my-env",
"from_id" : "42d4b302fd3c",
"id" : "67f1619a57d",
"status" : "in progress",
"status_changed_at" : "2020-05-22T14:59:01Z"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
A description of the Deployment.
DeploymentResponse
400
Error because the Delta is non-existent or incompatible with the state of the Environment.
HumanitecErrorResponse
404
No Environment with <code>id</code> in Application.
HumanitecErrorResponse
409
There is already an active deployment in the Environment.
HumanitecErrorResponse
Up
delete /orgs/{orgId}/resources/drivers/{driverId}
Delete a Resources Driver. (orgsOrgIdResourcesDriversDriverIdDelete)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
driverId (required)
Path Parameter — The Resources Driver ID to delete.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Record deleted.
500
Internal application error.
HumanitecErrorResponse
Up
get /orgs/{orgId}/resources/drivers/{driverId}
Get a Resource Driver. (orgsOrgIdResourcesDriversDriverIdGet)
Only drivers that belongs to the given organization or registered as public are accessible through this endpoint
Path parameters
orgId (required)
Path Parameter — The Organization ID.
driverId (required)
Path Parameter — The Resource Driver ID.
Return type
Example data
Content-Type: application/json
{
"account_types" : [ "gcp", "aws" ],
"id" : "route53",
"inputs_schema" : { },
"is_public" : false,
"org_id" : "test-org",
"target" : "https://drivers.example.com/route53/",
"template" : "",
"type" : "dns"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The requested Resources Driver details.
DriverDefinitionResponse
404
A Resource Driver with the 'driverId' ID is not found or is not accessible by the organization.
HumanitecErrorResponse
500
Internal application error.
HumanitecErrorResponse
Up
put /orgs/{orgId}/resources/drivers/{driverId}
Update a Resource Driver. (orgsOrgIdResourcesDriversDriverIdPut)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
driverId (required)
Path Parameter — The Resource Driver ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"account_types" : [ "gcp", "aws" ],
"id" : "route53",
"inputs_schema" : { },
"is_public" : false,
"org_id" : "test-org",
"target" : "https://drivers.example.com/route53/",
"template" : "",
"type" : "dns"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The updated Resources Driver details.
DriverDefinitionResponse
400
One or more request parameters is missing or invalid.
HumanitecErrorResponse
404
A Resources Driver with the 'driverId' ID is not found.
HumanitecErrorResponse
500
Internal application error.
HumanitecErrorResponse
Up
get /orgs/{orgId}/resources/drivers
List Resource Drivers. (orgsOrgIdResourcesDriversGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Return type
Example data
Content-Type: application/json
[ {
"account_types" : [ "gcp", "aws" ],
"id" : "route53",
"inputs_schema" : { },
"is_public" : false,
"org_id" : "test-org",
"target" : "https://drivers.example.com/route53/",
"template" : "",
"type" : "dns"
}, {
"account_types" : [ "gcp", "aws" ],
"id" : "route53",
"inputs_schema" : { },
"is_public" : false,
"org_id" : "test-org",
"target" : "https://drivers.example.com/route53/",
"template" : "",
"type" : "dns"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty list of Resources Drivers.
500
Internal application error.
HumanitecErrorResponse
Up
post /orgs/{orgId}/resources/drivers
Register a new Resource Driver. (orgsOrgIdResourcesDriversPost)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Resources Driver details.
Return type
Example data
Content-Type: application/json
{
"account_types" : [ "gcp", "aws" ],
"id" : "route53",
"inputs_schema" : { },
"is_public" : false,
"org_id" : "test-org",
"target" : "https://drivers.example.com/route53/",
"template" : "",
"type" : "dns"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The newly registered Resources Driver details.
DriverDefinitionResponse
400
One or more request parameters is missing or invalid.
HumanitecErrorResponse
409
A Resources Driver already exists.
HumanitecErrorResponse
500
Internal application error.
HumanitecErrorResponse
Up
delete /orgs/{orgId}/apps/{appId}/envs/{envId}
Delete a specific Environment. (orgsOrgIdAppsAppIdEnvsEnvIdDelete)
Deletes a specific Environment in an Application.
Deleting an Environment will also delete the Deployment history of the Environment.
Deletions are currently irreversible.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Environment successfully deleted.
400
Attempt to delete the last Environment in an Application.
HumanitecErrorResponse
404
No Environment with <code>envId</code> in Application.
HumanitecErrorResponse
Up
put /orgs/{orgId}/apps/{appId}/envs/{envId}/from_deploy_id
Rebase to a different Deployment. (orgsOrgIdAppsAppIdEnvsEnvIdFromDeployIdPut)
Rebasing an Environment means that the next Deployment to the Environment will be based on the Deployment specified in the rebase rather than the last one in the Environment. The Deployment to rebase to can either be current or a previous Deployment. The Deployment can be from any Environment of the same Application.
Running code will only be affected on the next Deployment to the Environment.
Common use cases for rebasing an Environment:
-
Rollback: Rebasing to a previous Deployment in the current Environment and then Deploying without additional changes will execute a rollback to the previous Deployment state.
-
Clone: Rebasing to the current Deployment in a different Environment and then deploying without additional changes will clone all of the configuration of the other Environment into the current one. (NOTE: External Resources will not be cloned in the process - the current External Resources of the Environment will remain unchanged and will be used by the deployed Application in the Environment.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The Deployment ID to rebase to.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Rebase successful.
400
No Deployment with ID found in Application.
HumanitecErrorResponse
404
No Environment with ID found in Application and Organization.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/envs/{envId}
Get a specific Environment. (orgsOrgIdAppsAppIdEnvsEnvIdGet)
Gets a specific Environment in an Application.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "a.user@example.com",
"from_deploy" : {
"comment" : "Updated version of module-one to v0.3.1",
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "a.user@example.com",
"delta_id" : "df1ad41807b0390a9b0eaf8688e1f5baece9d764",
"env_id" : "my-env",
"from_id" : "42d4b302fd3c",
"id" : "67f1619a57d",
"status" : "in progress",
"status_changed_at" : "2020-05-22T14:59:01Z"
},
"id" : "feature-test",
"last_deploy" : {
"comment" : "Updated version of module-one to v0.3.1",
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "a.user@example.com",
"delta_id" : "df1ad41807b0390a9b0eaf8688e1f5baece9d764",
"env_id" : "my-env",
"from_id" : "42d4b302fd3c",
"id" : "67f1619a57d",
"status" : "in progress",
"status_changed_at" : "2020-05-22T14:59:01Z"
},
"name" : "Feature Test",
"type" : "development"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The Environment requested.
EnvironmentResponse
Example data
Content-Type: application/json
{}
404
No Environment with <code>id</code> in Application.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/envs
List all Environments. (orgsOrgIdAppsAppIdEnvsGet)
Lists all of the Environments in the Application.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Return type
Example data
Content-Type: application/json
[ {
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "a.user@example.com",
"from_deploy" : {
"comment" : "Updated version of module-one to v0.3.1",
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "a.user@example.com",
"delta_id" : "df1ad41807b0390a9b0eaf8688e1f5baece9d764",
"env_id" : "my-env",
"from_id" : "42d4b302fd3c",
"id" : "67f1619a57d",
"status" : "in progress",
"status_changed_at" : "2020-05-22T14:59:01Z"
},
"id" : "feature-test",
"last_deploy" : {
"comment" : "Updated version of module-one to v0.3.1",
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "a.user@example.com",
"delta_id" : "df1ad41807b0390a9b0eaf8688e1f5baece9d764",
"env_id" : "my-env",
"from_id" : "42d4b302fd3c",
"id" : "67f1619a57d",
"status" : "in progress",
"status_changed_at" : "2020-05-22T14:59:01Z"
},
"name" : "Feature Test",
"type" : "development"
}, {
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "a.user@example.com",
"from_deploy" : {
"comment" : "Updated version of module-one to v0.3.1",
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "a.user@example.com",
"delta_id" : "df1ad41807b0390a9b0eaf8688e1f5baece9d764",
"env_id" : "my-env",
"from_id" : "42d4b302fd3c",
"id" : "67f1619a57d",
"status" : "in progress",
"status_changed_at" : "2020-05-22T14:59:01Z"
},
"id" : "feature-test",
"last_deploy" : {
"comment" : "Updated version of module-one to v0.3.1",
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "a.user@example.com",
"delta_id" : "df1ad41807b0390a9b0eaf8688e1f5baece9d764",
"env_id" : "my-env",
"from_id" : "42d4b302fd3c",
"id" : "67f1619a57d",
"status" : "in progress",
"status_changed_at" : "2020-05-22T14:59:01Z"
},
"name" : "Feature Test",
"type" : "development"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A list of Environments associated with an Application.
Example data
Content-Type: application/json
[{}]
Up
post /orgs/{orgId}/apps/{appId}/envs
Add a new Environment to an Application. (orgsOrgIdAppsAppIdEnvsPost)
Creates a new Environment of the specified Type and associates it with the Application specified by appId.
The Environment is also initialized to the current or past state of Deployment in another Environment. This ensures that every Environment is derived from a previously known state. This means it is not possible to create a new Environment for an Application until at least one Deployment has occurred. (The Deployment does not have to be successful.)
The Type of the Environment must be already defined in the Organization.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The ID, Name, Type, and Deployment the Environment will be derived from.
example: {
"from_deploy_id" : "e80db1a327208c1a",
"id" : "awesome-feature",
"name" : "Awesome Feature Dev",
"namespace" : "awesome-namespace",
"type" : "development"
}
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "a.user@example.com",
"from_deploy" : {
"comment" : "Updated version of module-one to v0.3.1",
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "a.user@example.com",
"delta_id" : "df1ad41807b0390a9b0eaf8688e1f5baece9d764",
"env_id" : "my-env",
"from_id" : "42d4b302fd3c",
"id" : "67f1619a57d",
"status" : "in progress",
"status_changed_at" : "2020-05-22T14:59:01Z"
},
"id" : "feature-test",
"last_deploy" : {
"comment" : "Updated version of module-one to v0.3.1",
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "a.user@example.com",
"delta_id" : "df1ad41807b0390a9b0eaf8688e1f5baece9d764",
"env_id" : "my-env",
"from_id" : "42d4b302fd3c",
"id" : "67f1619a57d",
"status" : "in progress",
"status_changed_at" : "2020-05-22T14:59:01Z"
},
"name" : "Feature Test",
"type" : "development"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The new Environment.
EnvironmentResponse
Example data
Content-Type: application/json
{}
400
The supplied <code>id</code> is an invalid ID or a required field is missing.
HumanitecErrorResponse
404
No Application with <code>id</code> in Organization.
HumanitecErrorResponse
409
The supplied <code>id</code> clashes with an existing Environment.
HumanitecErrorResponse
Up
delete /orgs/{orgId}/env-types/{envTypeId}
Deletes an Environment Type (orgsOrgIdEnvTypesEnvTypeIdDelete)
Deletes a specific Environment Type from an Organization. If there are Environments with this Type in the Organization, the operation will fail.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
envTypeId (required)
Path Parameter — ID of the Environment Type.
Return type
Example data
Content-Type: application/json
{
"description" : "Environments used for automated QA.",
"id" : "qa-automation"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
The Environment Type requested.
EnvironmentTypeResponse
401
The Authorization header was not present or invalid.
HumanitecErrorResponse
404
No Environment Type with ID <code>envTypeId</code> in Organization.
HumanitecErrorResponse
409
<p>There are 1 or more Environments with this Type.</p>
<p>To delete an Environment Type, there can be no Environments with that type in the Organization.</p>
Example data
Content-Type: application/json
[{"app_id":"my-app","env_id":"awesome-feature"},{"app_id":"my-app","env_id":"bugfix-7951"}]
Up
get /orgs/{orgId}/env-types/{envTypeId}
Get an Environment Type (orgsOrgIdEnvTypesEnvTypeIdGet)
Gets a specific Environment Type within an Organization.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
envTypeId (required)
Path Parameter — ID of the Environment Type.
Return type
Example data
Content-Type: application/json
{
"description" : "Environments used for automated QA.",
"id" : "qa-automation"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The Environment Type requested.
EnvironmentTypeResponse
404
No Environment Type with <code>id</code> in Organization.
HumanitecErrorResponse
Up
get /orgs/{orgId}/env-types
List all Environment Types (orgsOrgIdEnvTypesGet)
Lists all Environment Types in an Organization.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Return type
Example data
Content-Type: application/json
[ {
"description" : "Environments used for automated QA.",
"id" : "qa-automation"
}, {
"description" : "Environments used for automated QA.",
"id" : "qa-automation"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A list of Environment Types.
Up
post /orgs/{orgId}/env-types
Add a new Environment Type (orgsOrgIdEnvTypesPost)
Adds a new Environment Type to an Organization.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — New Environment Type.
Return type
Example data
Content-Type: application/json
{
"description" : "Environments used for automated QA.",
"id" : "qa-automation"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
The Environment Type requested.
EnvironmentTypeResponse
400
The supplied <code>id</code> is not a valid ID or a required field is missing.
HumanitecErrorResponse
401
The Authorization header was not present or invalid.
HumanitecErrorResponse
409
The supplied <code>id</code> clashes with an existing Environment Type.
HumanitecErrorResponse
Up
delete /orgs/{orgId}/apps/{appId}/jobs
Deletes all Jobs for the Application (orgsOrgIdAppsAppIdJobsDelete)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Responses
204
Deleted successfully.
Up
get /orgs/{orgId}/apps/{appId}/webhooks
List Webhooks (orgsOrgIdAppsAppIdWebhooksGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Return type
Example data
Content-Type: application/json
[ {
"headers" : {
"key" : ""
},
"created_at" : "2020-06-22T09:37:23.523Z",
"disabled" : true,
"id" : "id",
"triggers" : [ {
"scope" : "scope",
"type" : "type"
}, {
"scope" : "scope",
"type" : "type"
} ],
"created_by" : "created_by",
"url" : "url"
}, {
"headers" : {
"key" : ""
},
"created_at" : "2020-06-22T09:37:23.523Z",
"disabled" : true,
"id" : "id",
"triggers" : [ {
"scope" : "scope",
"type" : "type"
}, {
"scope" : "scope",
"type" : "type"
} ],
"created_by" : "created_by",
"url" : "url"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A list of Webhooks.
Up
delete /orgs/{orgId}/apps/{appId}/webhooks/{jobId}
Delete a Webhook (orgsOrgIdAppsAppIdWebhooksJobIdDelete)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
jobId (required)
Path Parameter — The Webhook ID.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Deleted successfully
404
The requested webhook not found.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/webhooks/{jobId}
Get a Webhook (orgsOrgIdAppsAppIdWebhooksJobIdGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
jobId (required)
Path Parameter — The Webhook ID.
Return type
Example data
Content-Type: application/json
{
"headers" : {
"key" : ""
},
"created_at" : "2020-06-22T09:37:23.523Z",
"disabled" : true,
"id" : "id",
"triggers" : [ {
"scope" : "scope",
"type" : "type"
}, {
"scope" : "scope",
"type" : "type"
} ],
"created_by" : "created_by",
"url" : "url"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The requested webhook.
WebhookResponse
404
The requested webhook not found.
HumanitecErrorResponse
Up
patch /orgs/{orgId}/apps/{appId}/webhooks/{jobId}
Update a Webhook (orgsOrgIdAppsAppIdWebhooksJobIdPatch)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
jobId (required)
Path Parameter — The Webhook ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"headers" : {
"key" : ""
},
"disabled" : true,
"triggers" : [ {
"scope" : "scope",
"type" : "type"
}, {
"scope" : "scope",
"type" : "type"
} ],
"url" : "url"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Updated successfully, return the webhook
WebhookUpdateResponse
400
Bad request
HumanitecErrorResponse
404
The requested webhook not found.
HumanitecErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/webhooks
Create a new Webhook (orgsOrgIdAppsAppIdWebhooksPost)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"headers" : {
"key" : ""
},
"created_at" : "2020-06-22T09:37:23.523Z",
"disabled" : true,
"id" : "id",
"triggers" : [ {
"scope" : "scope",
"type" : "type"
}, {
"scope" : "scope",
"type" : "type"
} ],
"created_by" : "created_by",
"url" : "url"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
A created webhook.
WebhookResponse
400
Some of the values supplied are invalid.
HumanitecErrorResponse
409
The supplied <code>id</code> clashes with an existing Job.
HumanitecErrorResponse
Up
get /orgs/{orgId}/events
List Events (orgsOrgIdEventsGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Return type
Example data
Content-Type: application/json
[ {
"scope" : "scope",
"type" : "type",
"properties" : [ "properties", "properties" ]
}, {
"scope" : "scope",
"type" : "type",
"properties" : [ "properties", "properties" ]
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A list of Events.
Up
get /orgs/{orgId}/humanitec-keys
List all the public keys Humanitec shares with an organization. (getHumanitecPublicKeys)
Path parameters
orgId (required)
Path Parameter — The organization ID.
Query parameters
active (optional)
Query Parameter — If set to true, the response includes only the active key, if set to false only non-active keys, otherwise both active and non-active keys.
Return type
Example data
Content-Type: application/json
[ {
"updated_at" : "2020-06-22T09:37:23.523Z",
"active" : true,
"created_at" : "2020-06-22T09:37:23.523Z",
"id" : "id",
"expired_at" : "2020-06-22T09:37:23.523Z",
"pub_key" : "pub_key"
}, {
"updated_at" : "2020-06-22T09:37:23.523Z",
"active" : true,
"created_at" : "2020-06-22T09:37:23.523Z",
"id" : "id",
"expired_at" : "2020-06-22T09:37:23.523Z",
"pub_key" : "pub_key"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possible empty list of public keys which Humanitec shares with an organization, sorted by the active value and descending by creation date.
Up
get /orgs/{orgId}/images
List all Container Images (orgsOrgIdImagesGet)
DEPRECATED: This endpoint exists for historical compatibility and should not be used. Please use the Artefact API instead.
Lists all of the Container Images registered for this organization.
Path parameters
orgId (required)
Path Parameter — The organization ID.
Return type
Example data
Content-Type: application/json
[ {
"added_at" : "22020-06-25T17:41:57Z",
"builds" : [ {
"added_at" : "2020-06-25T19:37:22Z",
"branch" : "master",
"commit" : "884bccaa807ea27cc1997a7492a3b6279fd7bd55",
"image" : "registry.humanitec.io/my-org/my-service:1.2.7"
}, {
"added_at" : "2020-06-25T17:41:57Z",
"branch" : "master",
"commit" : "060c3d6530a881afb808f105f36af25e1ad1b2f3",
"image" : "registry.humanitec.io/my-org/my-service:1.2.6"
} ],
"id" : "my-service",
"source" : "github"
}, {
"added_at" : "22020-06-25T17:41:57Z",
"builds" : [ {
"added_at" : "2020-06-25T19:37:22Z",
"branch" : "master",
"commit" : "884bccaa807ea27cc1997a7492a3b6279fd7bd55",
"image" : "registry.humanitec.io/my-org/my-service:1.2.7"
}, {
"added_at" : "2020-06-25T17:41:57Z",
"branch" : "master",
"commit" : "060c3d6530a881afb808f105f36af25e1ad1b2f3",
"image" : "registry.humanitec.io/my-org/my-service:1.2.6"
} ],
"id" : "my-service",
"source" : "github"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Possibly empty list of Container Images.
Example data
Content-Type: application/json
[{"added_at":"2020-05-12T16:12:13Z","builds":[{"added_at":"2020-06-25T19:37:22Z","branch":"master","commit":"884bccaa807ea27cc1997a7492a3b6279fd7bd55","image":"registry.humanitec.io/my-org/my-service:1.2.7"}],"id":"my-service","source":"github"}]
Up
get /orgs/{orgId}/images/{imageId}/builds
Lists all the Builds of an Image (orgsOrgIdImagesImageIdBuildsGet)
DEPRECATED: This endpoint exists for historical compatibility and should not be used. Please use the Artefact API instead.
The response lists all available Image Builds of an Image.
Path parameters
orgId (required)
Path Parameter — The organization ID.
imageId (required)
Path Parameter — The Image ID.
Return type
Example data
Content-Type: application/json
[ {
"added_at" : "2020-06-22T09:37:23.523Z",
"image" : "image",
"commit" : "commit",
"branch" : "branch",
"tags" : [ "tags", "tags" ]
}, {
"added_at" : "2020-06-22T09:37:23.523Z",
"image" : "image",
"commit" : "commit",
"branch" : "branch",
"tags" : [ "tags", "tags" ]
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Possibly empty list of Builds of Container Images.
Example data
Content-Type: application/json
[{"added_at":"2020-06-25T19:37:22Z","branch":"master","commit":"884bccaa807ea27cc1997a7492a3b6279fd7bd55","image":"registry.humanitec.io/my-org/my-service:1.2.7"},{"added_at":"2020-06-25T17:41:57Z","branch":"master","commit":"060c3d6530a881afb808f105f36af25e1ad1b2f3","image":"registry.humanitec.io/my-org/my-service:1.2.6"}]
404
No Image with an ID of <code>imageId</code> found within the organization.
HumanitecErrorResponse
Up
post /orgs/{orgId}/images/{imageId}/builds
Add a new Image Build (orgsOrgIdImagesImageIdBuildsPost)
DEPRECATED: This endpoint exists for historical compatibility and should not be used. Please use the Artefact API instead.
This endpoint is used by Continuous Integration (CI) pipelines to notify Humanitec that a new Image Build is available.
If there is no Image with ID imageId, it will be automatically created.
Path parameters
orgId (required)
Path Parameter — The organization ID.
imageId (required)
Path Parameter — The Image ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The metadata associated with the build.
example: {
"branch" : "master",
"commit" : "884bccaa807ea27cc1997a7492a3b6279fd7bd55",
"image" : "registry.humanitec.io/my-org/my-service:1.2.7"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Build successfully added.
400
The supplied <code>imageId</code> is invalid or a required field is missing.
HumanitecErrorResponse
401
Request unauthorised.
HumanitecErrorResponse
403
A build cannot be added to a builtin image.
HumanitecErrorResponse
Up
get /orgs/{orgId}/images/{imageId}
Get a specific Image Object (orgsOrgIdImagesImageIdGet)
DEPRECATED: This endpoint exists for historical compatibility and should not be used. Please use the Artefact API instead.
The response includes a list of Image Builds as well as some metadata about the Image such as its Image Source.
Note, imageId may not be the same as the container name. imageId is determined by the system making notifications about new builds.
Path parameters
orgId (required)
Path Parameter — The organization ID.
imageId (required)
Path Parameter — The Image ID.
Return type
Example data
Content-Type: application/json
{
"added_at" : "22020-06-25T17:41:57Z",
"builds" : [ {
"added_at" : "2020-06-25T19:37:22Z",
"branch" : "master",
"commit" : "884bccaa807ea27cc1997a7492a3b6279fd7bd55",
"image" : "registry.humanitec.io/my-org/my-service:1.2.7"
}, {
"added_at" : "2020-06-25T17:41:57Z",
"branch" : "master",
"commit" : "060c3d6530a881afb808f105f36af25e1ad1b2f3",
"image" : "registry.humanitec.io/my-org/my-service:1.2.6"
} ],
"id" : "my-service",
"source" : "github"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The Image Object requested.
ImageResponse
Example data
Content-Type: application/json
{"added_at":"22020-06-25T17:41:57Z","builds":[{"added_at":"2020-06-25T19:37:22Z","branch":"master","commit":"884bccaa807ea27cc1997a7492a3b6279fd7bd55","image":"registry.humanitec.io/my-org/my-service:1.2.7"},{"added_at":"2020-06-25T17:41:57Z","branch":"master","commit":"060c3d6530a881afb808f105f36af25e1ad1b2f3","image":"registry.humanitec.io/my-org/my-service:1.2.6"}],"id":"my-service","source":"github"}
404
No Image with an ID of <code>imageId</code> found within the organization.
HumanitecErrorResponse
Up
delete /orgs/{orgId}/resources/defs/{defId}/criteria/{criteriaId}
Delete a Matching Criteria from a Resource Definition. (orgsOrgIdResourcesDefsDefIdCriteriaCriteriaIdDelete)
If there are no Active Resources that would match to a different Resource Definition when the current Matching Criteria is deleted, the Matching Criteria is deleted immediately.
If there are Active Resources that would match to a different Resource Definition, the request fails with HTTP status code 409 (Conflict). The response content will list all of affected Active Resources and their new matches.
The request can take an optional force query parameter. If set to true, the Matching Criteria is deleted immediately. Referenced Active Resources would match to a different Resource Definition during the next deployment in the target environment.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
defId (required)
Path Parameter — The Resource Definition ID.
criteriaId (required)
Path Parameter — The Matching Criteria ID.
Query parameters
force (optional)
Query Parameter — If set to <code>true</code>, the Matching Criteria is deleted immediately, even if this action affects existing Active Resources.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Record deleted.
404
The Resource Definition is not found.
String
409
One or more Active Resources reference the Resource Definition through this Matching Criteria.
500
Internal application error.
HumanitecErrorResponse
Up
post /orgs/{orgId}/resources/defs/{defId}/criteria
Add a new Matching Criteria to a Resource Definition. (orgsOrgIdResourcesDefsDefIdCriteriaPost)
Matching Criteria are combined with Resource Type to select a specific definition. Matching Criteria can be set for any combination of Application ID, Environment ID, Environment Type, and Resource ID. In the event of multiple matches, the most specific match is chosen.
For example, given 3 sets of matching criteria for the same type:
1. {"env_type":"test"}
2. {"env_type":"development"}
3. {"env_type":"test", "app_id":"my-app"}
If, a resource of that time was needed in an Application my-app, Environment qa-team with Type test and Resource ID modules.my-module-externals.my-resource, there would be two resource definitions matching the criteria: #1 & #3. Definition #3 will be chosen because its matching criteria is the most specific.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
defId (required)
Path Parameter — The Resource Definition ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Matching Criteria rules.
example: {
"env_id" : "production"
}
Return type
Example data
Content-Type: application/json
{
"env_id" : "env_id",
"res_id" : "res_id",
"id" : "id",
"app_id" : "app_id",
"class" : "class",
"env_type" : "env_type"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The newly added Matching Criteria details.
MatchingCriteriaResponse
400
One or more request parameters is missing or invalid.
HumanitecErrorResponse
409
A Matching Criteria already exists.
HumanitecErrorResponse
500
Internal application error.
HumanitecErrorResponse
List active organizations the user has access to. (orgsGet)
Return type
Example data
Content-Type: application/json
[ {
"name" : "name",
"created_at" : "2020-06-22T09:37:23.523Z",
"logo" : {
"light_url" : "light_url",
"dark_url" : "dark_url"
},
"id" : "id",
"created_by" : "created_by"
}, {
"name" : "name",
"created_at" : "2020-06-22T09:37:23.523Z",
"logo" : {
"light_url" : "light_url",
"dark_url" : "dark_url"
},
"id" : "id",
"created_by" : "created_by"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A list of available organizations (based on the current user access level).
401
Required HTTP Authorization header is missing or malformed.
403
Current user is not authorized to perform the request.
Get the specified Organization. (orgsOrgIdGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Return type
Example data
Content-Type: application/json
{
"name" : "name",
"created_at" : "2020-06-22T09:37:23.523Z",
"logo" : {
"light_url" : "light_url",
"dark_url" : "dark_url"
},
"id" : "id",
"created_by" : "created_by"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Returns organization details.
OrganizationResponse
400
Invalid request parameters or payload. E.g. invalid <code>orgId</code> format.
HumanitecErrorResponse
401
Required HTTP Authorization header is missing or malformed.
403
Current user is not authorized to perform the request.
409
Organization can't be accessed with this request.
HumanitecErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/jobs/{jobId}/approvals/{approvalId}/approve
Approve the approval request (approveApprovalRequest)
Approve the approval requested.
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
runId (required)
Path Parameter — The Run ID
jobId (required)
Path Parameter — The Job ID
approvalId (required)
Path Parameter — The Approval ID
Return type
Example data
Content-Type: application/json
{
"approved_by" : "0123456789ab-cdef-0123-456789abcdef",
"run_id" : "01234567-89ab-cdef-0123-456789abcdef",
"env_id" : "production",
"org_id" : "sample-org",
"job_id" : "deploy",
"approved_at" : "2023-01-01T00:00:00Z",
"pipeline_id" : "sample-pipeline",
"created_at" : "2023-01-01T00:00:00Z",
"id" : "id",
"message" : "Promoting app to production",
"app_id" : "sample-app",
"status" : "waiting"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Request successfully approved.
ApprovalRequest
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
403
Server understands the request but refuses to authorize it.
ErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/jobs/{jobId}/approvals/{approvalId}/deny
Deny the approval request (denyApprovalRequest)
Deny the approval requested.
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
runId (required)
Path Parameter — The Run ID
jobId (required)
Path Parameter — The Job ID
approvalId (required)
Path Parameter — The Approval ID
Return type
Example data
Content-Type: application/json
{
"approved_by" : "0123456789ab-cdef-0123-456789abcdef",
"run_id" : "01234567-89ab-cdef-0123-456789abcdef",
"env_id" : "production",
"org_id" : "sample-org",
"job_id" : "deploy",
"approved_at" : "2023-01-01T00:00:00Z",
"pipeline_id" : "sample-pipeline",
"created_at" : "2023-01-01T00:00:00Z",
"id" : "id",
"message" : "Promoting app to production",
"app_id" : "sample-app",
"status" : "waiting"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Request successfully denied.
ApprovalRequest
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
403
Server understands the request but refuses to authorize it.
ErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/jobs/{jobId}/approvals/{approvalId}
Get an approval request (getApprovalRequest)
Get an approval request.
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
runId (required)
Path Parameter — The Run ID
jobId (required)
Path Parameter — The Job ID
approvalId (required)
Path Parameter — The Approval ID
Return type
Example data
Content-Type: application/json
{
"approved_by" : "0123456789ab-cdef-0123-456789abcdef",
"run_id" : "01234567-89ab-cdef-0123-456789abcdef",
"env_id" : "production",
"org_id" : "sample-org",
"job_id" : "deploy",
"approved_at" : "2023-01-01T00:00:00Z",
"pipeline_id" : "sample-pipeline",
"created_at" : "2023-01-01T00:00:00Z",
"id" : "id",
"message" : "Promoting app to production",
"app_id" : "sample-app",
"status" : "waiting"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful get approval request.
ApprovalRequest
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/approvals
List of the approval requests (listApprovalRequests)
List of the approval requests with in an app.
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
Query parameters
per_page (optional)
Query Parameter — The maximum number of items to return in a page of results default: 50
page (optional)
Query Parameter — The page token to request from
pipeline (optional)
Query Parameter — An optional list of Pipeline IDs.
run (optional)
Query Parameter — An optional Pipeline Run ID.
status (optional)
Query Parameter — Optional filter by status.
Return type
Example data
Content-Type: application/json
[ {
"approved_by" : "0123456789ab-cdef-0123-456789abcdef",
"run_id" : "01234567-89ab-cdef-0123-456789abcdef",
"env_id" : "production",
"org_id" : "sample-org",
"job_id" : "deploy",
"approved_at" : "2023-01-01T00:00:00Z",
"pipeline_id" : "sample-pipeline",
"created_at" : "2023-01-01T00:00:00Z",
"id" : "id",
"message" : "Promoting app to production",
"app_id" : "sample-app",
"status" : "waiting"
}, {
"approved_by" : "0123456789ab-cdef-0123-456789abcdef",
"run_id" : "01234567-89ab-cdef-0123-456789abcdef",
"env_id" : "production",
"org_id" : "sample-org",
"job_id" : "deploy",
"approved_at" : "2023-01-01T00:00:00Z",
"pipeline_id" : "sample-pipeline",
"created_at" : "2023-01-01T00:00:00Z",
"id" : "id",
"message" : "Promoting app to production",
"app_id" : "sample-app",
"status" : "waiting"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful list response.
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/cancel
Cancel a Run within an Pipeline. (cancelRun)
Attempts to cancel the specified Run. If the Run is in a queued state, this cancellation will be applied
immediately. If the Run is executing, the cancellation will be stored and will be resolved by the next
Job or Step that supports in-flight cancellation. Runs that are in any other state, are not cancellable.
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
runId (required)
Path Parameter — The Run ID
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Successful cancellation or the Run was already cancelled.
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
409
The request itself is valid however it could not be applied based on the current state of the resource.
More detail can be found in the error body.
HumanitecErrorResponse
412
The request itself is valid however it could not be applied because the Etag does not match.
ErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs
Create a run within a pipeline. (createPipelineRun)
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"pipeline_version" : "01234567-89ab-cdef-0123-456789abcdef",
"status_message" : "Example text",
"executing_at" : "2023-01-01T00:00:00Z",
"concurrency_group" : "my-group",
"inputs" : {
"fizz" : "buzz"
},
"created_at" : "2023-01-01T00:00:00Z",
"cancellation_requested_at" : "2023-01-01T00:00:00Z",
"run_as" : "s-01234567-89ab-cdef-0123-456789abcdef",
"waiting_for" : {
"key" : "waiting_for"
},
"completed_at" : "2023-01-01T00:00:00Z",
"org_id" : "sample-org",
"pipeline_id" : "sample-pipeline",
"etag" : "1234567890abcdef",
"id" : "01234567-89ab-cdef-0123-456789abcdef",
"timeout_seconds" : 3600,
"app_id" : "sample-app",
"status" : "executing"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Successful creation response.
RunResponse
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
409
The request itself is valid however it could not be applied based on the current state of the resource.
More detail can be found in the error body.
HumanitecErrorResponse
422
Server understands the content type of the request, and the syntax of the request is correct, but it was unable to process the contained instructions
ErrorResponse
Up
delete /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}
Deleting a completed Run within a Pipeline. (deleteRun)
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
runId (required)
Path Parameter — The Run ID
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Successfully deleted the Run.
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
409
The request itself is valid however it could not be applied based on the current state of the resource.
More detail can be found in the error body.
HumanitecErrorResponse
412
The request itself is valid however it could not be applied because the Etag does not match.
ErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}
Get a run within an pipeline. (getRun)
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
runId (required)
Path Parameter — The Run ID
Return type
Example data
Content-Type: application/json
{
"pipeline_version" : "01234567-89ab-cdef-0123-456789abcdef",
"status_message" : "Example text",
"executing_at" : "2023-01-01T00:00:00Z",
"concurrency_group" : "my-group",
"inputs" : {
"fizz" : "buzz"
},
"created_at" : "2023-01-01T00:00:00Z",
"cancellation_requested_at" : "2023-01-01T00:00:00Z",
"run_as" : "s-01234567-89ab-cdef-0123-456789abcdef",
"waiting_for" : {
"key" : "waiting_for"
},
"completed_at" : "2023-01-01T00:00:00Z",
"org_id" : "sample-org",
"pipeline_id" : "sample-pipeline",
"etag" : "1234567890abcdef",
"id" : "01234567-89ab-cdef-0123-456789abcdef",
"timeout_seconds" : 3600,
"app_id" : "sample-app",
"status" : "executing"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful get response.
RunResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/jobs/{jobId}
List the details of a Job including Step information (getRunJob)
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
runId (required)
Path Parameter — The Run ID
jobId (required)
Path Parameter — The Job ID
Return type
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful response
RunJobResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs
List runs within a pipeline. (listPipelineRuns)
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
Query parameters
status (optional)
Query Parameter — Optional filter by status.
completed (optional)
Query Parameter — Optional filer by completed or not.
created_after (optional)
Query Parameter — Optional filter by creation after date time. format: date-time
created_before (optional)
Query Parameter — Optional filter by creation before date time format: date-time
per_page (optional)
Query Parameter — The maximum number of items to return in a page of results default: 50
page (optional)
Query Parameter — The page token to request from
Return type
Example data
Content-Type: application/json
[ {
"pipeline_version" : "01234567-89ab-cdef-0123-456789abcdef",
"status_message" : "Example text",
"executing_at" : "2023-01-01T00:00:00Z",
"concurrency_group" : "my-group",
"inputs" : {
"fizz" : "buzz"
},
"created_at" : "2023-01-01T00:00:00Z",
"cancellation_requested_at" : "2023-01-01T00:00:00Z",
"run_as" : "s-01234567-89ab-cdef-0123-456789abcdef",
"waiting_for" : {
"key" : "waiting_for"
},
"completed_at" : "2023-01-01T00:00:00Z",
"org_id" : "sample-org",
"pipeline_id" : "sample-pipeline",
"etag" : "1234567890abcdef",
"id" : "01234567-89ab-cdef-0123-456789abcdef",
"timeout_seconds" : 3600,
"app_id" : "sample-app",
"status" : "executing"
}, {
"pipeline_version" : "01234567-89ab-cdef-0123-456789abcdef",
"status_message" : "Example text",
"executing_at" : "2023-01-01T00:00:00Z",
"concurrency_group" : "my-group",
"inputs" : {
"fizz" : "buzz"
},
"created_at" : "2023-01-01T00:00:00Z",
"cancellation_requested_at" : "2023-01-01T00:00:00Z",
"run_as" : "s-01234567-89ab-cdef-0123-456789abcdef",
"waiting_for" : {
"key" : "waiting_for"
},
"completed_at" : "2023-01-01T00:00:00Z",
"org_id" : "sample-org",
"pipeline_id" : "sample-pipeline",
"etag" : "1234567890abcdef",
"id" : "01234567-89ab-cdef-0123-456789abcdef",
"timeout_seconds" : 3600,
"app_id" : "sample-app",
"status" : "executing"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful list response. If the Link header is present, more data may be available.
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
Up
get /orgs/{orgId}/pipeline-runs
List all pipeline runs within the Org. This can be filtered by app, pipeline, and status. (listPipelineRunsByOrg)
Path parameters
orgId (required)
Path Parameter — The Organization ID
Query parameters
app (optional)
Query Parameter — An optional list of Application IDs.
pipeline (optional)
Query Parameter — An optional list of Pipeline IDs.
status (optional)
Query Parameter — Optional filter by status.
completed (optional)
Query Parameter — Optional filer by completed or not.
created_after (optional)
Query Parameter — Optional filter by creation after date time. format: date-time
created_before (optional)
Query Parameter — Optional filter by creation before date time format: date-time
per_page (optional)
Query Parameter — The maximum number of items to return in a page of results default: 50
page (optional)
Query Parameter — The page token to request from
Return type
Example data
Content-Type: application/json
[ {
"pipeline_version" : "01234567-89ab-cdef-0123-456789abcdef",
"status_message" : "Example text",
"executing_at" : "2023-01-01T00:00:00Z",
"concurrency_group" : "my-group",
"inputs" : {
"fizz" : "buzz"
},
"created_at" : "2023-01-01T00:00:00Z",
"cancellation_requested_at" : "2023-01-01T00:00:00Z",
"run_as" : "s-01234567-89ab-cdef-0123-456789abcdef",
"waiting_for" : {
"key" : "waiting_for"
},
"completed_at" : "2023-01-01T00:00:00Z",
"org_id" : "sample-org",
"pipeline_id" : "sample-pipeline",
"etag" : "1234567890abcdef",
"id" : "01234567-89ab-cdef-0123-456789abcdef",
"timeout_seconds" : 3600,
"app_id" : "sample-app",
"status" : "executing"
}, {
"pipeline_version" : "01234567-89ab-cdef-0123-456789abcdef",
"status_message" : "Example text",
"executing_at" : "2023-01-01T00:00:00Z",
"concurrency_group" : "my-group",
"inputs" : {
"fizz" : "buzz"
},
"created_at" : "2023-01-01T00:00:00Z",
"cancellation_requested_at" : "2023-01-01T00:00:00Z",
"run_as" : "s-01234567-89ab-cdef-0123-456789abcdef",
"waiting_for" : {
"key" : "waiting_for"
},
"completed_at" : "2023-01-01T00:00:00Z",
"org_id" : "sample-org",
"pipeline_id" : "sample-pipeline",
"etag" : "1234567890abcdef",
"id" : "01234567-89ab-cdef-0123-456789abcdef",
"timeout_seconds" : 3600,
"app_id" : "sample-app",
"status" : "executing"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful list response. If the Link header is present, more data may be available.
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/jobs/{jobId}/steps/{stepIndex}/logs
Get a page of log output for a given step within a job. (listRunJobStepLogs)
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
runId (required)
Path Parameter — The Run ID
jobId (required)
Path Parameter — The Job ID
stepIndex (required)
Path Parameter — The index of the step within the Job
Query parameters
page (optional)
Query Parameter — The page token to request from
Return type
Example data
Content-Type: application/json
[ {
"at" : "2023-01-01T00:00:00Z",
"level" : "INFO",
"message" : "Example message"
}, {
"at" : "2023-01-01T00:00:00Z",
"level" : "INFO",
"message" : "Example message"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful response
307
The content is available at a different location specified in the Location header.
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/jobs
List the details of the jobs with in a pipeline run. (listRunJobs)
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
runId (required)
Path Parameter — The Run ID
Query parameters
status (optional)
Query Parameter — Optional filter by status.
per_page (optional)
Query Parameter — The maximum number of items to return in a page of results default: 50
page (optional)
Query Parameter — The page token to request from
Return type
Example data
Content-Type: application/json
[ {
"pipeline_version" : "01234567-89ab-cdef-0123-456789abcdef",
"status_message" : "Example text",
"run_id" : "01234567-89ab-cdef-0123-456789abcdef",
"created_at" : "2023-01-01T00:00:00Z",
"cancellation_requested_at" : "2023-01-01T00:00:00Z",
"waiting_for" : "application.environment.deployment(test-deployment-id)",
"completed_at" : "2023-01-01T00:00:00Z",
"org_id" : "sample-org",
"pipeline_id" : "sample-pipeline",
"etag" : "1234567890abcdef",
"id" : "01234567-89ab-cdef-0123-456789abcdef",
"timeout_seconds" : 3600,
"app_id" : "sample-app",
"status" : "executing"
}, {
"pipeline_version" : "01234567-89ab-cdef-0123-456789abcdef",
"status_message" : "Example text",
"run_id" : "01234567-89ab-cdef-0123-456789abcdef",
"created_at" : "2023-01-01T00:00:00Z",
"cancellation_requested_at" : "2023-01-01T00:00:00Z",
"waiting_for" : "application.environment.deployment(test-deployment-id)",
"completed_at" : "2023-01-01T00:00:00Z",
"org_id" : "sample-org",
"pipeline_id" : "sample-pipeline",
"etag" : "1234567890abcdef",
"id" : "01234567-89ab-cdef-0123-456789abcdef",
"timeout_seconds" : 3600,
"app_id" : "sample-app",
"status" : "executing"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful list response.
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/restart
Restart a Run within an Pipeline by cloning it with the same trigger and inputs. (restartRun)
Attempts to copy and restart the specified Run. The run must be in a completed state.
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
runId (required)
Path Parameter — The Run ID
Request headers
Return type
Example data
Content-Type: application/json
{
"pipeline_version" : "01234567-89ab-cdef-0123-456789abcdef",
"status_message" : "Example text",
"executing_at" : "2023-01-01T00:00:00Z",
"concurrency_group" : "my-group",
"inputs" : {
"fizz" : "buzz"
},
"created_at" : "2023-01-01T00:00:00Z",
"cancellation_requested_at" : "2023-01-01T00:00:00Z",
"run_as" : "s-01234567-89ab-cdef-0123-456789abcdef",
"waiting_for" : {
"key" : "waiting_for"
},
"completed_at" : "2023-01-01T00:00:00Z",
"org_id" : "sample-org",
"pipeline_id" : "sample-pipeline",
"etag" : "1234567890abcdef",
"id" : "01234567-89ab-cdef-0123-456789abcdef",
"timeout_seconds" : 3600,
"app_id" : "sample-app",
"status" : "executing"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Successful restart response.
RunResponse
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
409
The request itself is valid however it could not be applied based on the current state of the resource.
More detail can be found in the error body.
HumanitecErrorResponse
422
Server understands the content type of the request, and the syntax of the request is correct, but it was unable to process the contained instructions
ErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/pipelines
Create a Pipeline within an Application. (createPipeline)
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"metadata" : {
"key" : "metadata"
},
"trigger_types" : [ "pipeline_call" ],
"org_id" : "sample-org",
"name" : "Sample Pipeline",
"created_at" : "2023-01-01T00:00:00Z",
"etag" : "1234567890abcdef",
"id" : "sample-pipeline",
"app_id" : "sample-app",
"version" : "01234567-89ab-cdef-0123-456789abcdef",
"status" : "active"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Successful creation response.
Pipeline
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
409
The request itself is valid however it could not be applied based on the current state of the resource.
More detail can be found in the error body.
HumanitecErrorResponse
Up
delete /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}
Delete a pipeline within an application. (deletePipeline)
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Pipeline has been successfully deleted
202
Request for pipeline deletion successfully committed
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
409
The request itself is valid however it could not be applied based on the current state of the resource.
More detail can be found in the error body.
HumanitecErrorResponse
412
The request itself is valid however it could not be applied because the Etag does not match.
ErrorResponse
Up
get /orgs/{orgId}/pipeline-schemas/latest
Gets the latest pipeline schema (getLatestPipelineDefinitionSchema)
Path parameters
orgId (required)
Path Parameter — The Organization ID
Return type
Object
Example data
Content-Type: application/json
{ }
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful get response.
Object
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}
Get a Pipeline within an Application. (getPipeline)
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
Query parameters
version (optional)
Query Parameter — An optional Pipeline Version ID.
Return type
Example data
Content-Type: application/json
{
"metadata" : {
"key" : "metadata"
},
"trigger_types" : [ "pipeline_call" ],
"org_id" : "sample-org",
"name" : "Sample Pipeline",
"created_at" : "2023-01-01T00:00:00Z",
"etag" : "1234567890abcdef",
"id" : "sample-pipeline",
"app_id" : "sample-app",
"version" : "01234567-89ab-cdef-0123-456789abcdef",
"status" : "active"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful get response.
Pipeline
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/schema
Get a pipeline schema. (getPipelineDefinition)
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
Request headers
Query parameters
version (optional)
Query Parameter — An optional Pipeline Version ID.
Return type
Object
Example data
Content-Type: application/json
{ }
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/x.humanitec-pipelines-v1.0+yamlapplication/json
Responses
200
Successful get response.
Object
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/versions
List all versions of the pipeline (listPipelineVersions)
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
Query parameters
per_page (optional)
Query Parameter — The maximum number of items to return in a page of results default: 50
page (optional)
Query Parameter — The page token to request from
Return type
Example data
Content-Type: application/json
[ {
"org_id" : "sample-org",
"pipeline_id" : "sample-pipeline",
"created_at" : "2023-01-01T00:00:00Z",
"id" : "01234567-89ab-cdef-0123-456789abcdef",
"app_id" : "sample-app",
"created_by" : "01234567-89ab-cdef-0123-456789abcdef"
}, {
"org_id" : "sample-org",
"pipeline_id" : "sample-pipeline",
"created_at" : "2023-01-01T00:00:00Z",
"id" : "01234567-89ab-cdef-0123-456789abcdef",
"app_id" : "sample-app",
"created_by" : "01234567-89ab-cdef-0123-456789abcdef"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful list response. If the Link header is present, more data may be available.
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/pipelines
List Pipelines within an Application. (listPipelines)
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
Query parameters
per_page (optional)
Query Parameter — The maximum number of items to return in a page of results default: 50
page (optional)
Query Parameter — The page token to request from
trigger (optional)
Query Parameter — An optional filter by trigger type.
Return type
Example data
Content-Type: application/json
[ {
"metadata" : {
"key" : "metadata"
},
"trigger_types" : [ "pipeline_call" ],
"org_id" : "sample-org",
"name" : "Sample Pipeline",
"created_at" : "2023-01-01T00:00:00Z",
"etag" : "1234567890abcdef",
"id" : "sample-pipeline",
"app_id" : "sample-app",
"version" : "01234567-89ab-cdef-0123-456789abcdef",
"status" : "active"
}, {
"metadata" : {
"key" : "metadata"
},
"trigger_types" : [ "pipeline_call" ],
"org_id" : "sample-org",
"name" : "Sample Pipeline",
"created_at" : "2023-01-01T00:00:00Z",
"etag" : "1234567890abcdef",
"id" : "sample-pipeline",
"app_id" : "sample-app",
"version" : "01234567-89ab-cdef-0123-456789abcdef",
"status" : "active"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful list response. If the Link header is present, more data may be available.
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
Up
get /orgs/{orgId}/pipelines
List all Pipelines within an Organization. This can be filtered by Application. (listPipelinesInOrg)
Path parameters
orgId (required)
Path Parameter — The Organization ID
Query parameters
app (optional)
Query Parameter — An optional list of Application IDs.
per_page (optional)
Query Parameter — The maximum number of items to return in a page of results default: 50
page (optional)
Query Parameter — The page token to request from
trigger (optional)
Query Parameter — An optional filter by trigger type.
Return type
Example data
Content-Type: application/json
[ {
"metadata" : {
"key" : "metadata"
},
"trigger_types" : [ "pipeline_call" ],
"org_id" : "sample-org",
"name" : "Sample Pipeline",
"created_at" : "2023-01-01T00:00:00Z",
"etag" : "1234567890abcdef",
"id" : "sample-pipeline",
"app_id" : "sample-app",
"version" : "01234567-89ab-cdef-0123-456789abcdef",
"status" : "active"
}, {
"metadata" : {
"key" : "metadata"
},
"trigger_types" : [ "pipeline_call" ],
"org_id" : "sample-org",
"name" : "Sample Pipeline",
"created_at" : "2023-01-01T00:00:00Z",
"etag" : "1234567890abcdef",
"id" : "sample-pipeline",
"app_id" : "sample-app",
"version" : "01234567-89ab-cdef-0123-456789abcdef",
"status" : "active"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful list response. If the Link header is present, more data may be available.
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
Up
patch /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}
update a Pipeline within an Application. (updatePipeline)
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"metadata" : {
"key" : "metadata"
},
"trigger_types" : [ "pipeline_call" ],
"org_id" : "sample-org",
"name" : "Sample Pipeline",
"created_at" : "2023-01-01T00:00:00Z",
"etag" : "1234567890abcdef",
"id" : "sample-pipeline",
"app_id" : "sample-app",
"version" : "01234567-89ab-cdef-0123-456789abcdef",
"status" : "active"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful get response.
Pipeline
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
409
The request itself is valid however it could not be applied based on the current state of the resource.
More detail can be found in the error body.
HumanitecErrorResponse
412
The request itself is valid however it could not be applied because the Etag does not match.
ErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/jobs/{jobId}/approvals/{approvalId}/approve
Approve the approval request (approveApprovalRequest)
Approve the approval requested.
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
runId (required)
Path Parameter — The Run ID
jobId (required)
Path Parameter — The Job ID
approvalId (required)
Path Parameter — The Approval ID
Return type
Example data
Content-Type: application/json
{
"approved_by" : "0123456789ab-cdef-0123-456789abcdef",
"run_id" : "01234567-89ab-cdef-0123-456789abcdef",
"env_id" : "production",
"org_id" : "sample-org",
"job_id" : "deploy",
"approved_at" : "2023-01-01T00:00:00Z",
"pipeline_id" : "sample-pipeline",
"created_at" : "2023-01-01T00:00:00Z",
"id" : "id",
"message" : "Promoting app to production",
"app_id" : "sample-app",
"status" : "waiting"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Request successfully approved.
ApprovalRequest
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
403
Server understands the request but refuses to authorize it.
ErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/cancel
Cancel a Run within an Pipeline. (cancelRun)
Attempts to cancel the specified Run. If the Run is in a queued state, this cancellation will be applied
immediately. If the Run is executing, the cancellation will be stored and will be resolved by the next
Job or Step that supports in-flight cancellation. Runs that are in any other state, are not cancellable.
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
runId (required)
Path Parameter — The Run ID
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Successful cancellation or the Run was already cancelled.
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
409
The request itself is valid however it could not be applied based on the current state of the resource.
More detail can be found in the error body.
HumanitecErrorResponse
412
The request itself is valid however it could not be applied because the Etag does not match.
ErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/pipelines
Create a Pipeline within an Application. (createPipeline)
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"metadata" : {
"key" : "metadata"
},
"trigger_types" : [ "pipeline_call" ],
"org_id" : "sample-org",
"name" : "Sample Pipeline",
"created_at" : "2023-01-01T00:00:00Z",
"etag" : "1234567890abcdef",
"id" : "sample-pipeline",
"app_id" : "sample-app",
"version" : "01234567-89ab-cdef-0123-456789abcdef",
"status" : "active"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Successful creation response.
Pipeline
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
409
The request itself is valid however it could not be applied based on the current state of the resource.
More detail can be found in the error body.
HumanitecErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs
Create a run within a pipeline. (createPipelineRun)
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"pipeline_version" : "01234567-89ab-cdef-0123-456789abcdef",
"status_message" : "Example text",
"executing_at" : "2023-01-01T00:00:00Z",
"concurrency_group" : "my-group",
"inputs" : {
"fizz" : "buzz"
},
"created_at" : "2023-01-01T00:00:00Z",
"cancellation_requested_at" : "2023-01-01T00:00:00Z",
"run_as" : "s-01234567-89ab-cdef-0123-456789abcdef",
"waiting_for" : {
"key" : "waiting_for"
},
"completed_at" : "2023-01-01T00:00:00Z",
"org_id" : "sample-org",
"pipeline_id" : "sample-pipeline",
"etag" : "1234567890abcdef",
"id" : "01234567-89ab-cdef-0123-456789abcdef",
"timeout_seconds" : 3600,
"app_id" : "sample-app",
"status" : "executing"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Successful creation response.
RunResponse
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
409
The request itself is valid however it could not be applied based on the current state of the resource.
More detail can be found in the error body.
HumanitecErrorResponse
422
Server understands the content type of the request, and the syntax of the request is correct, but it was unable to process the contained instructions
ErrorResponse
Up
post /orgs/{orgId}/keys
Associate a new RSA public key to an organization. (createPublicKey)
Path parameters
orgId (required)
Path Parameter — The organization ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — A pcks8 RSA public key PEM encoded (as the ones produced by openssl), whose module length is greater or equal than 4096 bits. It should be provided as a single line. This might be accomplished through the usage of <code>awk</code> bash tool: <code>awk -v ORS='\n' '1' public_key.pem</code>
example: "-----BEGIN PUBLIC KEY-----\\nMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAo22jj/h+WPhL5M8RUyqC\\nEqRK3FOYD6KuDTyUHZL2QUX/q35bT1aGIOtu+22oM/8hTZ/6+BTknvF+Z+e7At8E\\n/I6/qNZilJFH/HqNHYflykceILVCFQM6v0ar6CSPh88DjwQPGLrh+UYp0NKBF6D5\\n2LEVQpxsM/0qV4fOZngRVI9UeKiYehk8aXJi20nI5Cj9GnV7BuEo7sKq7NewTOMN\\nwHqSnCtMV+E7SIgyy4+aKAFHOR0Y4FgJN14bAjE2GX/VUmAYBNtPgGwkCNDbA9v1\\nJJnFmdKflp8foqeWwC9UcUDLqjZzMT2a16pnL89iHV4fJ4vI6h26Jf2wUJbb7xE3\\nxJNhCR9Qf2IHx8TTVetIRl5I/ZUPkRrq5iskOIWV4+I+NzS+gbnCUv6sCO3cnZaa\\noZ4Wk5V+5qfctANeTn0TEAabYAJ/zFgYcs2IwYNqcN5eTss99zGNgtDL3oJr/A6g\\neGBgzad3p80qPMb1le64cHAAFZaerI2kcdnNpWGLXJ/J7IKF9uNfsrvi7Zdv8AXg\\nVAyqBARfzSkgnUKN6iWkWxAAzylKnQ3Etw81huaLwDG/6Lqd8I5OePMwHEZkollD\\nEBD16L/iyV9veru2zLVXkX/nL64YtZERLOWI5NUMaSurAR4N3ptFAsDRcO5Z4+Dq\\nO3pqszSh1aCyJvyl6cjQLT8CAwEAAQ==\\n-----END PUBLIC KEY-----\\n"
Return type
Example data
Content-Type: application/json
{
"fingerprint" : "fingerprint",
"created_at" : "2020-06-22T09:37:23.523Z",
"id" : "id",
"expired_at" : "2020-06-22T09:37:23.523Z",
"created_by" : "created_by",
"key" : "key"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Public Key added successfully.
PublicKey
400
Bad input provided.
HumanitecErrorResponse
403
Forbidden, only administrators can create new public key.
HumanitecErrorResponse
409
A public key with the same value already exists.
HumanitecErrorResponse
Up
post /orgs/{orgId}/workload-profile-chart-versions
Add new Workload Profile Chart Version (createWorkloadProfileChartVersion)
Creates a Workload Profile Chart Version from the uploaded Helm chart. The name and version is retrieved from the chart's metadata (Charts.yaml file).
The request has content type multipart/form-data and the request body includes one part:
file with application/x-gzip content type which is an archive containing a Helm chart.
Request body example:
Content-Type: multipart/form-data; boundary=----boundary ----boundary Content-Disposition: form-data; name="file"; filename="my-workload-1.0.1.tgz" Content-Type: application/x-gzip [TGZ_DATA] ----boundary
Path parameters
orgId (required)
Path Parameter — The Organization ID
Consumes
This API call consumes the following media types via the request header:
Form parameters
file (required)
Form Parameter — format: binary
Return type
Example data
Content-Type: application/json
{
"org_id" : "org_id",
"created_at" : "2020-06-22T09:37:23.523Z",
"id" : "id",
"created_by" : "created_by",
"version" : "version"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
The newly created Workload Profile Chart Version metadata.
WorkloadProfileChartVersionResponse
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
409
The request itself is valid however it could not be applied based on the current state of the resource.
More detail can be found in the error body.
HumanitecErrorResponse
Up
post /orgs/{orgId}/workload-profiles/{profileQid}/versions
Add new Version of the Workload Profile (createWorkloadProfileVersion)
Creates a Workload Profile Version for the given Workload Profile.
Path parameters
orgId (required)
Path Parameter — The Organization ID
profileQid (required)
Path Parameter — The Workload Profile ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Workload profile version metadata.
Return type
Example data
Content-Type: application/json
{
"workload_profile_chart" : {
"id" : "id",
"version" : "version"
},
"features" : "",
"spec_definition" : {
"runtime_properties" : [ null, null ],
"properties" : {
"key" : {
"schema" : "",
"feature_name" : "feature_name",
"type" : "feature",
"title" : "title",
"runtime_properties" : [ {
"feature_name" : "feature_name",
"type" : "feature",
"title" : "title",
"version" : "version"
}, {
"feature_name" : "feature_name",
"type" : "feature",
"title" : "title",
"version" : "version"
} ],
"version" : "version",
"ui_hints" : {
"hidden" : true,
"order" : 0
}
}
}
},
"notes" : "notes",
"spec_schema" : "",
"org_id" : "org_id",
"profile_id" : "profile_id",
"created_at" : "2020-06-22T09:37:23.523Z",
"created_by" : "created_by",
"version" : "version"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
The newly created Workload Profile Version metadata.
WorkloadProfileVersionResponse
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
409
The request itself is valid however it could not be applied based on the current state of the resource.
More detail can be found in the error body.
HumanitecErrorResponse
Gets the extended profile of the current user (currentUserGet)
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "d510224a-4641-48fd-8054-68efd3537ee2",
"name" : "Jo Trigg",
"properties" : {
"dont_show_welcome_screen" : true
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The extended user profile of the user.
UserProfileExtendedResponse
401
No token supplied.
403
Token is not valid for a user.
Updates the extended profile of the current user. (currentUserPatch)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "d510224a-4641-48fd-8054-68efd3537ee2",
"name" : "Jo Trigg",
"properties" : {
"dont_show_welcome_screen" : true
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The extended user profile of the user.
UserProfileExtendedResponse
400
The request was invalid or the payload malformed.
HumanitecErrorResponse
401
No token supplied.
403
Token is not valid for a user.
Up
delete /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}
Delete a pipeline within an application. (deletePipeline)
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Pipeline has been successfully deleted
202
Request for pipeline deletion successfully committed
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
409
The request itself is valid however it could not be applied based on the current state of the resource.
More detail can be found in the error body.
HumanitecErrorResponse
412
The request itself is valid however it could not be applied because the Etag does not match.
ErrorResponse
Up
delete /orgs/{orgId}/keys/{keyId}
Delete a public key associated to an organization. (deletePublicKey)
Path parameters
orgId (required)
Path Parameter — The organization ID.
keyId (required)
Path Parameter — The public key ID.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Public Key successfully removed.
403
Forbidden, only administrators can delete public keys.
HumanitecErrorResponse
404
Public key not found.
HumanitecErrorResponse
Up
delete /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}
Deleting a completed Run within a Pipeline. (deleteRun)
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
runId (required)
Path Parameter — The Run ID
Request headers
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Successfully deleted the Run.
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
409
The request itself is valid however it could not be applied based on the current state of the resource.
More detail can be found in the error body.
HumanitecErrorResponse
412
The request itself is valid however it could not be applied because the Etag does not match.
ErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/jobs/{jobId}/approvals/{approvalId}/deny
Deny the approval request (denyApprovalRequest)
Deny the approval requested.
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
runId (required)
Path Parameter — The Run ID
jobId (required)
Path Parameter — The Job ID
approvalId (required)
Path Parameter — The Approval ID
Return type
Example data
Content-Type: application/json
{
"approved_by" : "0123456789ab-cdef-0123-456789abcdef",
"run_id" : "01234567-89ab-cdef-0123-456789abcdef",
"env_id" : "production",
"org_id" : "sample-org",
"job_id" : "deploy",
"approved_at" : "2023-01-01T00:00:00Z",
"pipeline_id" : "sample-pipeline",
"created_at" : "2023-01-01T00:00:00Z",
"id" : "id",
"message" : "Promoting app to production",
"app_id" : "sample-app",
"status" : "waiting"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Request successfully denied.
ApprovalRequest
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
403
Server understands the request but refuses to authorize it.
ErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/jobs/{jobId}/approvals/{approvalId}
Get an approval request (getApprovalRequest)
Get an approval request.
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
runId (required)
Path Parameter — The Run ID
jobId (required)
Path Parameter — The Job ID
approvalId (required)
Path Parameter — The Approval ID
Return type
Example data
Content-Type: application/json
{
"approved_by" : "0123456789ab-cdef-0123-456789abcdef",
"run_id" : "01234567-89ab-cdef-0123-456789abcdef",
"env_id" : "production",
"org_id" : "sample-org",
"job_id" : "deploy",
"approved_at" : "2023-01-01T00:00:00Z",
"pipeline_id" : "sample-pipeline",
"created_at" : "2023-01-01T00:00:00Z",
"id" : "id",
"message" : "Promoting app to production",
"app_id" : "sample-app",
"status" : "waiting"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful get approval request.
ApprovalRequest
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/deltas/{deltaId}
Fetch an existing Delta (getDelta)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
deltaId (required)
Path Parameter — ID of the Delta to fetch.
Return type
Example data
Content-Type: application/json
{
"id" : "49393b5004d072000b8abfd910c61685eb9235f5",
"metadata" : { },
"modules" : {
"add" : {
"redis-cache" : {
"profile" : "humanitec/redis"
}
},
"remove" : [ "simple-service" ],
"update" : {
"module-one" : [ {
"op" : "replace",
"path" : "/spec/containers/core-service/variables/EXAMPLE",
"value" : "New Value"
} ]
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The requested Deployment Delta.
DeltaResponse
404
No Deployment Delta with ID <code>deltaId</code> found in Application.
String
Up
get /orgs/{orgId}/humanitec-keys
List all the public keys Humanitec shares with an organization. (getHumanitecPublicKeys)
Path parameters
orgId (required)
Path Parameter — The organization ID.
Query parameters
active (optional)
Query Parameter — If set to true, the response includes only the active key, if set to false only non-active keys, otherwise both active and non-active keys.
Return type
Example data
Content-Type: application/json
[ {
"updated_at" : "2020-06-22T09:37:23.523Z",
"active" : true,
"created_at" : "2020-06-22T09:37:23.523Z",
"id" : "id",
"expired_at" : "2020-06-22T09:37:23.523Z",
"pub_key" : "pub_key"
}, {
"updated_at" : "2020-06-22T09:37:23.523Z",
"active" : true,
"created_at" : "2020-06-22T09:37:23.523Z",
"id" : "id",
"expired_at" : "2020-06-22T09:37:23.523Z",
"pub_key" : "pub_key"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possible empty list of public keys which Humanitec shares with an organization, sorted by the active value and descending by creation date.
Up
get /orgs/{orgId}/pipeline-schemas/latest
Gets the latest pipeline schema (getLatestPipelineDefinitionSchema)
Path parameters
orgId (required)
Path Parameter — The Organization ID
Return type
Object
Example data
Content-Type: application/json
{ }
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful get response.
Object
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
Up
get /orgs/{orgId}/workload-profiles/{profileQid}/versions/latest
Latest version of the given workload profile with optional constraint. (getLatestWorkloadProfileVersion)
Path parameters
orgId (required)
Path Parameter — The Organization ID
profileQid (required)
Path Parameter — The Workload Profile ID.
Return type
Example data
Content-Type: application/json
{
"workload_profile_chart" : {
"id" : "id",
"version" : "version"
},
"features" : "",
"spec_definition" : {
"runtime_properties" : [ null, null ],
"properties" : {
"key" : {
"schema" : "",
"feature_name" : "feature_name",
"type" : "feature",
"title" : "title",
"runtime_properties" : [ {
"feature_name" : "feature_name",
"type" : "feature",
"title" : "title",
"version" : "version"
}, {
"feature_name" : "feature_name",
"type" : "feature",
"title" : "title",
"version" : "version"
} ],
"version" : "version",
"ui_hints" : {
"hidden" : true,
"order" : 0
}
}
}
},
"notes" : "notes",
"spec_schema" : "",
"org_id" : "org_id",
"profile_id" : "profile_id",
"created_at" : "2020-06-22T09:37:23.523Z",
"created_by" : "created_by",
"version" : "version"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty list of Workload Profile Versions.
WorkloadProfileVersionResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}
Get a Pipeline within an Application. (getPipeline)
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
Query parameters
version (optional)
Query Parameter — An optional Pipeline Version ID.
Return type
Example data
Content-Type: application/json
{
"metadata" : {
"key" : "metadata"
},
"trigger_types" : [ "pipeline_call" ],
"org_id" : "sample-org",
"name" : "Sample Pipeline",
"created_at" : "2023-01-01T00:00:00Z",
"etag" : "1234567890abcdef",
"id" : "sample-pipeline",
"app_id" : "sample-app",
"version" : "01234567-89ab-cdef-0123-456789abcdef",
"status" : "active"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful get response.
Pipeline
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/schema
Get a pipeline schema. (getPipelineDefinition)
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
Request headers
Query parameters
version (optional)
Query Parameter — An optional Pipeline Version ID.
Return type
Object
Example data
Content-Type: application/json
{ }
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
application/x.humanitec-pipelines-v1.0+yamlapplication/json
Responses
200
Successful get response.
Object
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
Up
get /orgs/{orgId}/keys/{keyId}
Retrieve a single public key associated to an organization. (getPublicKey)
Path parameters
orgId (required)
Path Parameter — The organization ID.
keyId (required)
Path Parameter — The public key ID.
Return type
Example data
Content-Type: application/json
{
"fingerprint" : "fingerprint",
"created_at" : "2020-06-22T09:37:23.523Z",
"id" : "id",
"expired_at" : "2020-06-22T09:37:23.523Z",
"created_by" : "created_by",
"key" : "key"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A public key associated to an organization.
PublicKey
404
Public key not found.
HumanitecErrorResponse
Up
get /orgs/{orgId}/keys
List all public keys associated to an organization. (getPublicKeys)
Path parameters
orgId (required)
Path Parameter — The organization ID.
Query parameters
fingerprint (optional)
Query Parameter — The fingerprint of the requested key. If a value is provided, the result will contain a single key, if any.
Return type
Example data
Content-Type: application/json
[ {
"fingerprint" : "fingerprint",
"created_at" : "2020-06-22T09:37:23.523Z",
"id" : "id",
"expired_at" : "2020-06-22T09:37:23.523Z",
"created_by" : "created_by",
"key" : "key"
}, {
"fingerprint" : "fingerprint",
"created_at" : "2020-06-22T09:37:23.523Z",
"id" : "id",
"expired_at" : "2020-06-22T09:37:23.523Z",
"created_by" : "created_by",
"key" : "key"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possible empty list of public keys associated to an organization, sorted descending by creation date.
400
Provided fingerprint is not valid.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}
Get a run within an pipeline. (getRun)
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
runId (required)
Path Parameter — The Run ID
Return type
Example data
Content-Type: application/json
{
"pipeline_version" : "01234567-89ab-cdef-0123-456789abcdef",
"status_message" : "Example text",
"executing_at" : "2023-01-01T00:00:00Z",
"concurrency_group" : "my-group",
"inputs" : {
"fizz" : "buzz"
},
"created_at" : "2023-01-01T00:00:00Z",
"cancellation_requested_at" : "2023-01-01T00:00:00Z",
"run_as" : "s-01234567-89ab-cdef-0123-456789abcdef",
"waiting_for" : {
"key" : "waiting_for"
},
"completed_at" : "2023-01-01T00:00:00Z",
"org_id" : "sample-org",
"pipeline_id" : "sample-pipeline",
"etag" : "1234567890abcdef",
"id" : "01234567-89ab-cdef-0123-456789abcdef",
"timeout_seconds" : 3600,
"app_id" : "sample-app",
"status" : "executing"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful get response.
RunResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/jobs/{jobId}
List the details of a Job including Step information (getRunJob)
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
runId (required)
Path Parameter — The Run ID
jobId (required)
Path Parameter — The Job ID
Return type
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful response
RunJobResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/sets
Get all Deployment Sets (getSets)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Return type
Example data
Content-Type: application/json
[ {
"modules" : {
"module-one" : {
"externals" : {
"db-one" : {
"params" : {
"extensions" : {
"uuid-ossp" : { }
}
},
"type" : "postgres"
}
},
"profile" : "humanitec/default-module",
"spec" : {
"containers" : {
"core-service" : {
"id" : "core-service",
"image" : "registry.humanitec.io/my-org/core-service:VERSION_ONE",
"readiness_probe" : {
"path" : "/healtz",
"port" : 8080,
"type" : "http"
},
"variables" : {
"DBHOST" : "${externals.db-one.name}",
"DBNAME" : "${externals.db-one.name}",
"DBPASSWORD" : "${externals.db-one.password}",
"DBUSERNAME" : "${externals.db-one.username}",
"REDIS_URL" : "redis://${modules.redis-cache.service.name}"
}
}
}
}
},
"redis-cache" : {
"profile" : "humanitec/redis"
}
}
}, {
"modules" : {
"module-one" : {
"externals" : {
"db-one" : {
"params" : {
"extensions" : {
"uuid-ossp" : { }
}
},
"type" : "postgres"
}
},
"profile" : "humanitec/default-module",
"spec" : {
"containers" : {
"core-service" : {
"id" : "core-service",
"image" : "registry.humanitec.io/my-org/core-service:VERSION_ONE",
"readiness_probe" : {
"path" : "/healtz",
"port" : 8080,
"type" : "http"
},
"variables" : {
"DBHOST" : "${externals.db-one.name}",
"DBNAME" : "${externals.db-one.name}",
"DBPASSWORD" : "${externals.db-one.password}",
"DBUSERNAME" : "${externals.db-one.username}",
"REDIS_URL" : "redis://${modules.redis-cache.service.name}"
}
}
}
}
},
"redis-cache" : {
"profile" : "humanitec/redis"
}
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The Requested Deployment Set.
404
No Deployment Set with ID <code>setId</code> found in Application.
String
Up
get /orgs/{orgId}/apps/{appId}/approvals
List of the approval requests (listApprovalRequests)
List of the approval requests with in an app.
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
Query parameters
per_page (optional)
Query Parameter — The maximum number of items to return in a page of results default: 50
page (optional)
Query Parameter — The page token to request from
pipeline (optional)
Query Parameter — An optional list of Pipeline IDs.
run (optional)
Query Parameter — An optional Pipeline Run ID.
status (optional)
Query Parameter — Optional filter by status.
Return type
Example data
Content-Type: application/json
[ {
"approved_by" : "0123456789ab-cdef-0123-456789abcdef",
"run_id" : "01234567-89ab-cdef-0123-456789abcdef",
"env_id" : "production",
"org_id" : "sample-org",
"job_id" : "deploy",
"approved_at" : "2023-01-01T00:00:00Z",
"pipeline_id" : "sample-pipeline",
"created_at" : "2023-01-01T00:00:00Z",
"id" : "id",
"message" : "Promoting app to production",
"app_id" : "sample-app",
"status" : "waiting"
}, {
"approved_by" : "0123456789ab-cdef-0123-456789abcdef",
"run_id" : "01234567-89ab-cdef-0123-456789abcdef",
"env_id" : "production",
"org_id" : "sample-org",
"job_id" : "deploy",
"approved_at" : "2023-01-01T00:00:00Z",
"pipeline_id" : "sample-pipeline",
"created_at" : "2023-01-01T00:00:00Z",
"id" : "id",
"message" : "Promoting app to production",
"app_id" : "sample-app",
"status" : "waiting"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful list response.
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs
List runs within a pipeline. (listPipelineRuns)
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
Query parameters
status (optional)
Query Parameter — Optional filter by status.
completed (optional)
Query Parameter — Optional filer by completed or not.
created_after (optional)
Query Parameter — Optional filter by creation after date time. format: date-time
created_before (optional)
Query Parameter — Optional filter by creation before date time format: date-time
per_page (optional)
Query Parameter — The maximum number of items to return in a page of results default: 50
page (optional)
Query Parameter — The page token to request from
Return type
Example data
Content-Type: application/json
[ {
"pipeline_version" : "01234567-89ab-cdef-0123-456789abcdef",
"status_message" : "Example text",
"executing_at" : "2023-01-01T00:00:00Z",
"concurrency_group" : "my-group",
"inputs" : {
"fizz" : "buzz"
},
"created_at" : "2023-01-01T00:00:00Z",
"cancellation_requested_at" : "2023-01-01T00:00:00Z",
"run_as" : "s-01234567-89ab-cdef-0123-456789abcdef",
"waiting_for" : {
"key" : "waiting_for"
},
"completed_at" : "2023-01-01T00:00:00Z",
"org_id" : "sample-org",
"pipeline_id" : "sample-pipeline",
"etag" : "1234567890abcdef",
"id" : "01234567-89ab-cdef-0123-456789abcdef",
"timeout_seconds" : 3600,
"app_id" : "sample-app",
"status" : "executing"
}, {
"pipeline_version" : "01234567-89ab-cdef-0123-456789abcdef",
"status_message" : "Example text",
"executing_at" : "2023-01-01T00:00:00Z",
"concurrency_group" : "my-group",
"inputs" : {
"fizz" : "buzz"
},
"created_at" : "2023-01-01T00:00:00Z",
"cancellation_requested_at" : "2023-01-01T00:00:00Z",
"run_as" : "s-01234567-89ab-cdef-0123-456789abcdef",
"waiting_for" : {
"key" : "waiting_for"
},
"completed_at" : "2023-01-01T00:00:00Z",
"org_id" : "sample-org",
"pipeline_id" : "sample-pipeline",
"etag" : "1234567890abcdef",
"id" : "01234567-89ab-cdef-0123-456789abcdef",
"timeout_seconds" : 3600,
"app_id" : "sample-app",
"status" : "executing"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful list response. If the Link header is present, more data may be available.
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
Up
get /orgs/{orgId}/pipeline-runs
List all pipeline runs within the Org. This can be filtered by app, pipeline, and status. (listPipelineRunsByOrg)
Path parameters
orgId (required)
Path Parameter — The Organization ID
Query parameters
app (optional)
Query Parameter — An optional list of Application IDs.
pipeline (optional)
Query Parameter — An optional list of Pipeline IDs.
status (optional)
Query Parameter — Optional filter by status.
completed (optional)
Query Parameter — Optional filer by completed or not.
created_after (optional)
Query Parameter — Optional filter by creation after date time. format: date-time
created_before (optional)
Query Parameter — Optional filter by creation before date time format: date-time
per_page (optional)
Query Parameter — The maximum number of items to return in a page of results default: 50
page (optional)
Query Parameter — The page token to request from
Return type
Example data
Content-Type: application/json
[ {
"pipeline_version" : "01234567-89ab-cdef-0123-456789abcdef",
"status_message" : "Example text",
"executing_at" : "2023-01-01T00:00:00Z",
"concurrency_group" : "my-group",
"inputs" : {
"fizz" : "buzz"
},
"created_at" : "2023-01-01T00:00:00Z",
"cancellation_requested_at" : "2023-01-01T00:00:00Z",
"run_as" : "s-01234567-89ab-cdef-0123-456789abcdef",
"waiting_for" : {
"key" : "waiting_for"
},
"completed_at" : "2023-01-01T00:00:00Z",
"org_id" : "sample-org",
"pipeline_id" : "sample-pipeline",
"etag" : "1234567890abcdef",
"id" : "01234567-89ab-cdef-0123-456789abcdef",
"timeout_seconds" : 3600,
"app_id" : "sample-app",
"status" : "executing"
}, {
"pipeline_version" : "01234567-89ab-cdef-0123-456789abcdef",
"status_message" : "Example text",
"executing_at" : "2023-01-01T00:00:00Z",
"concurrency_group" : "my-group",
"inputs" : {
"fizz" : "buzz"
},
"created_at" : "2023-01-01T00:00:00Z",
"cancellation_requested_at" : "2023-01-01T00:00:00Z",
"run_as" : "s-01234567-89ab-cdef-0123-456789abcdef",
"waiting_for" : {
"key" : "waiting_for"
},
"completed_at" : "2023-01-01T00:00:00Z",
"org_id" : "sample-org",
"pipeline_id" : "sample-pipeline",
"etag" : "1234567890abcdef",
"id" : "01234567-89ab-cdef-0123-456789abcdef",
"timeout_seconds" : 3600,
"app_id" : "sample-app",
"status" : "executing"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful list response. If the Link header is present, more data may be available.
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/versions
List all versions of the pipeline (listPipelineVersions)
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
Query parameters
per_page (optional)
Query Parameter — The maximum number of items to return in a page of results default: 50
page (optional)
Query Parameter — The page token to request from
Return type
Example data
Content-Type: application/json
[ {
"org_id" : "sample-org",
"pipeline_id" : "sample-pipeline",
"created_at" : "2023-01-01T00:00:00Z",
"id" : "01234567-89ab-cdef-0123-456789abcdef",
"app_id" : "sample-app",
"created_by" : "01234567-89ab-cdef-0123-456789abcdef"
}, {
"org_id" : "sample-org",
"pipeline_id" : "sample-pipeline",
"created_at" : "2023-01-01T00:00:00Z",
"id" : "01234567-89ab-cdef-0123-456789abcdef",
"app_id" : "sample-app",
"created_by" : "01234567-89ab-cdef-0123-456789abcdef"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful list response. If the Link header is present, more data may be available.
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/pipelines
List Pipelines within an Application. (listPipelines)
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
Query parameters
per_page (optional)
Query Parameter — The maximum number of items to return in a page of results default: 50
page (optional)
Query Parameter — The page token to request from
trigger (optional)
Query Parameter — An optional filter by trigger type.
Return type
Example data
Content-Type: application/json
[ {
"metadata" : {
"key" : "metadata"
},
"trigger_types" : [ "pipeline_call" ],
"org_id" : "sample-org",
"name" : "Sample Pipeline",
"created_at" : "2023-01-01T00:00:00Z",
"etag" : "1234567890abcdef",
"id" : "sample-pipeline",
"app_id" : "sample-app",
"version" : "01234567-89ab-cdef-0123-456789abcdef",
"status" : "active"
}, {
"metadata" : {
"key" : "metadata"
},
"trigger_types" : [ "pipeline_call" ],
"org_id" : "sample-org",
"name" : "Sample Pipeline",
"created_at" : "2023-01-01T00:00:00Z",
"etag" : "1234567890abcdef",
"id" : "sample-pipeline",
"app_id" : "sample-app",
"version" : "01234567-89ab-cdef-0123-456789abcdef",
"status" : "active"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful list response. If the Link header is present, more data may be available.
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
Up
get /orgs/{orgId}/pipelines
List all Pipelines within an Organization. This can be filtered by Application. (listPipelinesInOrg)
Path parameters
orgId (required)
Path Parameter — The Organization ID
Query parameters
app (optional)
Query Parameter — An optional list of Application IDs.
per_page (optional)
Query Parameter — The maximum number of items to return in a page of results default: 50
page (optional)
Query Parameter — The page token to request from
trigger (optional)
Query Parameter — An optional filter by trigger type.
Return type
Example data
Content-Type: application/json
[ {
"metadata" : {
"key" : "metadata"
},
"trigger_types" : [ "pipeline_call" ],
"org_id" : "sample-org",
"name" : "Sample Pipeline",
"created_at" : "2023-01-01T00:00:00Z",
"etag" : "1234567890abcdef",
"id" : "sample-pipeline",
"app_id" : "sample-app",
"version" : "01234567-89ab-cdef-0123-456789abcdef",
"status" : "active"
}, {
"metadata" : {
"key" : "metadata"
},
"trigger_types" : [ "pipeline_call" ],
"org_id" : "sample-org",
"name" : "Sample Pipeline",
"created_at" : "2023-01-01T00:00:00Z",
"etag" : "1234567890abcdef",
"id" : "sample-pipeline",
"app_id" : "sample-app",
"version" : "01234567-89ab-cdef-0123-456789abcdef",
"status" : "active"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful list response. If the Link header is present, more data may be available.
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/jobs/{jobId}/steps/{stepIndex}/logs
Get a page of log output for a given step within a job. (listRunJobStepLogs)
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
runId (required)
Path Parameter — The Run ID
jobId (required)
Path Parameter — The Job ID
stepIndex (required)
Path Parameter — The index of the step within the Job
Query parameters
page (optional)
Query Parameter — The page token to request from
Return type
Example data
Content-Type: application/json
[ {
"at" : "2023-01-01T00:00:00Z",
"level" : "INFO",
"message" : "Example message"
}, {
"at" : "2023-01-01T00:00:00Z",
"level" : "INFO",
"message" : "Example message"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful response
307
The content is available at a different location specified in the Location header.
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/jobs
List the details of the jobs with in a pipeline run. (listRunJobs)
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
runId (required)
Path Parameter — The Run ID
Query parameters
status (optional)
Query Parameter — Optional filter by status.
per_page (optional)
Query Parameter — The maximum number of items to return in a page of results default: 50
page (optional)
Query Parameter — The page token to request from
Return type
Example data
Content-Type: application/json
[ {
"pipeline_version" : "01234567-89ab-cdef-0123-456789abcdef",
"status_message" : "Example text",
"run_id" : "01234567-89ab-cdef-0123-456789abcdef",
"created_at" : "2023-01-01T00:00:00Z",
"cancellation_requested_at" : "2023-01-01T00:00:00Z",
"waiting_for" : "application.environment.deployment(test-deployment-id)",
"completed_at" : "2023-01-01T00:00:00Z",
"org_id" : "sample-org",
"pipeline_id" : "sample-pipeline",
"etag" : "1234567890abcdef",
"id" : "01234567-89ab-cdef-0123-456789abcdef",
"timeout_seconds" : 3600,
"app_id" : "sample-app",
"status" : "executing"
}, {
"pipeline_version" : "01234567-89ab-cdef-0123-456789abcdef",
"status_message" : "Example text",
"run_id" : "01234567-89ab-cdef-0123-456789abcdef",
"created_at" : "2023-01-01T00:00:00Z",
"cancellation_requested_at" : "2023-01-01T00:00:00Z",
"waiting_for" : "application.environment.deployment(test-deployment-id)",
"completed_at" : "2023-01-01T00:00:00Z",
"org_id" : "sample-org",
"pipeline_id" : "sample-pipeline",
"etag" : "1234567890abcdef",
"id" : "01234567-89ab-cdef-0123-456789abcdef",
"timeout_seconds" : 3600,
"app_id" : "sample-app",
"status" : "executing"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful list response.
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
Up
get /orgs/{orgId}/workload-profile-chart-versions
Workload Profile Chart Versions for the given organization. (listWorkloadProfileChartVersions)
Returns all Workload Profile Chart Versions for the given organization.
Path parameters
orgId (required)
Path Parameter — The Organization ID
Query parameters
per_page (optional)
Query Parameter — The maximum number of items to return in a page of results default: 50
page (optional)
Query Parameter — The page token to request from
Return type
Example data
Content-Type: application/json
[ {
"org_id" : "org_id",
"created_at" : "2020-06-22T09:37:23.523Z",
"id" : "id",
"created_by" : "created_by",
"version" : "version"
}, {
"org_id" : "org_id",
"created_at" : "2020-06-22T09:37:23.523Z",
"id" : "id",
"created_by" : "created_by",
"version" : "version"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
List of Workload Profile Chart Versions.
Up
get /orgs/{orgId}/workload-profiles/{profileQid}/versions
List versions of the given workload profile. (listWorkloadProfileVersions)
Path parameters
orgId (required)
Path Parameter — The Organization ID
profileQid (required)
Path Parameter — The Workload Profile ID.
Query parameters
per_page (optional)
Query Parameter — The maximum number of items to return in a page of results default: 50
page (optional)
Query Parameter — The page token to request from
Return type
Example data
Content-Type: application/json
[ {
"workload_profile_chart" : {
"id" : "id",
"version" : "version"
},
"features" : "",
"spec_definition" : {
"runtime_properties" : [ null, null ],
"properties" : {
"key" : {
"schema" : "",
"feature_name" : "feature_name",
"type" : "feature",
"title" : "title",
"runtime_properties" : [ {
"feature_name" : "feature_name",
"type" : "feature",
"title" : "title",
"version" : "version"
}, {
"feature_name" : "feature_name",
"type" : "feature",
"title" : "title",
"version" : "version"
} ],
"version" : "version",
"ui_hints" : {
"hidden" : true,
"order" : 0
}
}
}
},
"notes" : "notes",
"spec_schema" : "",
"org_id" : "org_id",
"profile_id" : "profile_id",
"created_at" : "2020-06-22T09:37:23.523Z",
"created_by" : "created_by",
"version" : "version"
}, {
"workload_profile_chart" : {
"id" : "id",
"version" : "version"
},
"features" : "",
"spec_definition" : {
"runtime_properties" : [ null, null ],
"properties" : {
"key" : {
"schema" : "",
"feature_name" : "feature_name",
"type" : "feature",
"title" : "title",
"runtime_properties" : [ {
"feature_name" : "feature_name",
"type" : "feature",
"title" : "title",
"version" : "version"
}, {
"feature_name" : "feature_name",
"type" : "feature",
"title" : "title",
"version" : "version"
} ],
"version" : "version",
"ui_hints" : {
"hidden" : true,
"order" : 0
}
}
}
},
"notes" : "notes",
"spec_schema" : "",
"org_id" : "org_id",
"profile_id" : "profile_id",
"created_at" : "2020-06-22T09:37:23.523Z",
"created_by" : "created_by",
"version" : "version"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
List of Workload Profile Versions.
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
List active organizations the user has access to. (orgsGet)
Return type
Example data
Content-Type: application/json
[ {
"name" : "name",
"created_at" : "2020-06-22T09:37:23.523Z",
"logo" : {
"light_url" : "light_url",
"dark_url" : "dark_url"
},
"id" : "id",
"created_by" : "created_by"
}, {
"name" : "name",
"created_at" : "2020-06-22T09:37:23.523Z",
"logo" : {
"light_url" : "light_url",
"dark_url" : "dark_url"
},
"id" : "id",
"created_by" : "created_by"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A list of available organizations (based on the current user access level).
401
Required HTTP Authorization header is missing or malformed.
403
Current user is not authorized to perform the request.
Up
delete /orgs/{orgId}/apps/{appId}
Delete an Application (orgsOrgIdAppsAppIdDelete)
Deleting an Application will also delete everything associated with it. This includes Environments, Deployment history on those Environments, and any shared values and secrets associated.
Deletions are currently irreversible.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Application Successfully deleted.
401
The Authorization header was not present or invalid.
HumanitecErrorResponse
404
No Application with <code>id</code> in Organization.
HumanitecErrorResponse
Up
put /orgs/{orgId}/apps/{appId}/deltas/{deltaId}/metadata/archived
Mark a Delta as "archived" (orgsOrgIdAppsAppIdDeltasDeltaIdMetadataArchivedPut)
Archived Deltas are still accessible but can no longer be updated.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
deltaId (required)
Path Parameter — ID of the Deployment Delta.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Either <code>true</code> or <code>false</code>.
example: true
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Archived state successfully updated.
400
The request was invalid.
HumanitecErrorResponse
404
No Deployment Delta with ID <code>deltaId</code> found in Application.
String
Up
put /orgs/{orgId}/apps/{appId}/deltas/{deltaId}/metadata/env_id
Change the Environment of a Delta (orgsOrgIdAppsAppIdDeltasDeltaIdMetadataEnvIdPut)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
deltaId (required)
Path Parameter — ID of the Deployment Delta.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The new Environment ID. (NOTE: The string must still be JSON encoded.)
example: "new-env"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Environment ID successfully updated.
400
The request was invalid.
HumanitecErrorResponse
404
No Deployment Delta with ID <code>deltaId</code> found in Application.
String
Up
put /orgs/{orgId}/apps/{appId}/deltas/{deltaId}/metadata/name
Change the name of a Delta (orgsOrgIdAppsAppIdDeltasDeltaIdMetadataNamePut)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
deltaId (required)
Path Parameter — ID of the Deployment Delta.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The new name.(NOTE: The string must still be JSON encoded.)
example: "Update for ticket #s 2568 & 2572"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Name successfully updated.
400
The request was invalid.
HumanitecErrorResponse
404
No Deployment Delta with ID <code>deltaId</code> found in Application.
String
Up
patch /orgs/{orgId}/apps/{appId}/deltas/{deltaId}
Update an existing Delta (orgsOrgIdAppsAppIdDeltasDeltaIdPatch)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
deltaId (required)
Path Parameter — ID of the Delta to update.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — <p>An array of Deltas.</p>
<p>The Deltas in the request are combined, meaning the current Delta is updated in turn by each Delta in the request. Once all Deltas have been combined, the resulting Delta is simplified.</p>
<ul>
<li>
<p>All Modules in the <code>modules.add</code> property are replaced with the new Delta's values. If the value of a Module is <code>null</code>, and the ID is in the <code>modules.remove</code> list, it is removed from the <code>modules.remove</code> list.</p>
</li>
<li>
<p>All IDs listed in <code>modules.remove</code> are combined. Any ID in <code>modules.remove</code> and also in <code>modules.add</code> are removed from <code>modules.add</code></p>
</li>
<li>
<p>The lists of JSON Patches in <code>modules.update</code> are concatenated or created in <code>modules.updates</code>.</p>
</li>
</ul>
<p>Simplification involves:</p>
<ul>
<li>
<p>Applying any entries in <code>modules.updates</code> that have matching IDs in <code>modules.add</code> to the <code>modules.add</code> entry and removing the <code>modules.update</code> entry.</p>
</li>
<li>
<p>Reducing the number of JSON Patches in each <code>modules.update</code> entry to the smallest set that has the same effect.</p>
</li>
</ul>
<p><strong>Extension to JSON Patch</strong></p>
<p>If a JSON Patch entry needs to be removed, without side effects, the <code>value</code> of the <code>remove</code> action can be set to `{"scope": "delta"}. This will result in the remove action being used during simplification but be discarded before the Delta is finalized.</p>
<p>If the user making the request is not the user who created the Delta and they are not already on the contributors list, they will be added to the contributors list.</p>
<p><em>NOTE: If the <code>id</code> or <code>metadata</code> properties are specified, they will be ignored.</em></p>
example: [ {
"modules" : {
"updates" : {
"module-one" : [ {
"op" : "add",
"path" : "/spec/containers/simple-service/variables/REDIS_URL",
"value" : "redis://${modules.redis-cache.service.name}"
} ]
}
}
} ]
Return type
Example data
Content-Type: application/json
{
"id" : "49393b5004d072000b8abfd910c61685eb9235f5",
"metadata" : { },
"modules" : {
"add" : {
"redis-cache" : {
"profile" : "humanitec/redis"
}
},
"remove" : [ "simple-service" ],
"update" : {
"module-one" : [ {
"op" : "replace",
"path" : "/spec/containers/core-service/variables/EXAMPLE",
"value" : "New Value"
} ]
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The requested Deployment Delta.
DeltaResponse
400
The request was invalid.
HumanitecErrorResponse
404
No Deployment Delta with ID <code>deltaId</code> found in Application.
String
Up
get /orgs/{orgId}/apps/{appId}/deltas
List Deltas in an Application (orgsOrgIdAppsAppIdDeltasGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Query parameters
archived (optional)
Query Parameter — If true, return archived Deltas.
env (optional)
Query Parameter — Only return Deltas associated with the specified Environment.
Return type
Example data
Content-Type: application/json
[ {
"id" : "49393b5004d072000b8abfd910c61685eb9235f5",
"metadata" : { },
"modules" : {
"add" : {
"redis-cache" : {
"profile" : "humanitec/redis"
}
},
"remove" : [ "simple-service" ],
"update" : {
"module-one" : [ {
"op" : "replace",
"path" : "/spec/containers/core-service/variables/EXAMPLE",
"value" : "New Value"
} ]
}
}
}, {
"id" : "49393b5004d072000b8abfd910c61685eb9235f5",
"metadata" : { },
"modules" : {
"add" : {
"redis-cache" : {
"profile" : "humanitec/redis"
}
},
"remove" : [ "simple-service" ],
"update" : {
"module-one" : [ {
"op" : "replace",
"path" : "/spec/containers/core-service/variables/EXAMPLE",
"value" : "New Value"
} ]
}
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty list of Deployment Deltas.
Up
post /orgs/{orgId}/apps/{appId}/deltas
Create a new Delta (orgsOrgIdAppsAppIdDeltasPost)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — <p>A Deployment Delta to create.</p>
<p>The Deployment Delta will be added with the provided content of <code>modules</code> and the 'env_id' and 'name' properties of the 'metadata' property.</p>
<p>NOTE: If the <code>id</code> property is specified, it will be ignored. A new ID will be generated and returned in the response.</p>
example: {
"metadata" : {
"env_id" : "feature-test",
"name" : "Updates for ticket # 2581"
},
"modules" : {
"updates" : {
"module-one" : [ {
"op" : "add",
"path" : "/spec/containers/simple-service/variables/REDIS_URL",
"value" : "redis://${modules.redis-cache.service.name}"
} ]
}
}
}
Return type
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The requested Deployment Delta.
inline_response_200
400
The request was invalid.
HumanitecErrorResponse
Up
delete /orgs/{orgId}/apps/{appId}/envs/{envId}
Delete a specific Environment. (orgsOrgIdAppsAppIdEnvsEnvIdDelete)
Deletes a specific Environment in an Application.
Deleting an Environment will also delete the Deployment history of the Environment.
Deletions are currently irreversible.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Environment successfully deleted.
400
Attempt to delete the last Environment in an Application.
HumanitecErrorResponse
404
No Environment with <code>envId</code> in Application.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/envs/{envId}/deploys/{deployId}/errors
List errors that occurred in a Deployment. (orgsOrgIdAppsAppIdEnvsEnvIdDeploysDeployIdErrorsGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
deployId (required)
Path Parameter — The Deployment ID.
Return type
Example data
Content-Type: application/json
[ {
"code" : "CLD-001",
"message" : "Incorrect cloud provider credentials.",
"object_id" : "my-workload",
"scope" : "workload",
"summary" : "Provider error"
}, {
"code" : "CLD-001",
"message" : "Incorrect cloud provider credentials.",
"object_id" : "my-workload",
"scope" : "workload",
"summary" : "Provider error"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A List of deployment errors, could be empty.
Example data
Content-Type: application/json
[{"code":"CLD-001","message":"Incorrect credentials","object_id":"my-service","scope":"workload"}]
Up
get /orgs/{orgId}/apps/{appId}/envs/{envId}/deploys/{deployId}
Get a specific Deployment. (orgsOrgIdAppsAppIdEnvsEnvIdDeploysDeployIdGet)
Gets a specific Deployment in an Application and an Environment.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
deployId (required)
Path Parameter — The Deployment ID.
Return type
Example data
Content-Type: application/json
{
"comment" : "Updated version of module-one to v0.3.1",
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "a.user@example.com",
"delta_id" : "df1ad41807b0390a9b0eaf8688e1f5baece9d764",
"env_id" : "my-env",
"from_id" : "42d4b302fd3c",
"id" : "67f1619a57d",
"status" : "in progress",
"status_changed_at" : "2020-05-22T14:59:01Z"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The Deployment requested.
DeploymentResponse
Example data
Content-Type: application/json
{}
404
No Deployment with <code>deployId</code> in Application and Environment.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/envs/{envId}/deploys
List Deployments in an Environment. (orgsOrgIdAppsAppIdEnvsEnvIdDeploysGet)
List all of the Deployments that have been carried out in the current Environment. Deployments are returned with the newest first.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
Return type
Example data
Content-Type: application/json
[ {
"comment" : "Updated version of module-one to v0.3.1",
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "a.user@example.com",
"delta_id" : "df1ad41807b0390a9b0eaf8688e1f5baece9d764",
"env_id" : "my-env",
"from_id" : "42d4b302fd3c",
"id" : "67f1619a57d",
"status" : "in progress",
"status_changed_at" : "2020-05-22T14:59:01Z"
}, {
"comment" : "Updated version of module-one to v0.3.1",
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "a.user@example.com",
"delta_id" : "df1ad41807b0390a9b0eaf8688e1f5baece9d764",
"env_id" : "my-env",
"from_id" : "42d4b302fd3c",
"id" : "67f1619a57d",
"status" : "in progress",
"status_changed_at" : "2020-05-22T14:59:01Z"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty list of Deployments.
Example data
Content-Type: application/json
[{}]
404
No Environment with <code>id</code> in Application.
HumanitecErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/envs/{envId}/deploys
Start a new Deployment. (orgsOrgIdAppsAppIdEnvsEnvIdDeploysPost)
At Humanitec, Deployments are defined as changes to the state of the Environment. The state can be changed by defining a set of desired changes to the current state via a Deployment Delta or by resetting the current state after a previous Deployment. (See Environment Rebase.) Both types of changes can be combined into a single Deployment during which the Delta is applied to the Rebased state.
When specifying a Delta, a Delta ID must be used. That Delta must have been committed to the Delta store prior to the Deployment.
A Set ID can also be defined in the deployment to force the state of the environment to a particular state. This will be ignored if the Delta is specified.
NOTE:
Directly setting a set_id in a deployment is not recommended as it will not record history of where the set came from. If the intention is to replicate an existing environment, use the environment rebasing approach described above.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The Delta describing the change to the Environment and a comment.
example: {
"comment" : "Updated version of module-one to v0.3.1",
"delta_id" : "df1ad41807b0390a9b0eaf8688e1f5baece9d764"
}
Return type
Example data
Content-Type: application/json
{
"comment" : "Updated version of module-one to v0.3.1",
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "a.user@example.com",
"delta_id" : "df1ad41807b0390a9b0eaf8688e1f5baece9d764",
"env_id" : "my-env",
"from_id" : "42d4b302fd3c",
"id" : "67f1619a57d",
"status" : "in progress",
"status_changed_at" : "2020-05-22T14:59:01Z"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
A description of the Deployment.
DeploymentResponse
400
Error because the Delta is non-existent or incompatible with the state of the Environment.
HumanitecErrorResponse
404
No Environment with <code>id</code> in Application.
HumanitecErrorResponse
409
There is already an active deployment in the Environment.
HumanitecErrorResponse
Up
put /orgs/{orgId}/apps/{appId}/envs/{envId}/from_deploy_id
Rebase to a different Deployment. (orgsOrgIdAppsAppIdEnvsEnvIdFromDeployIdPut)
Rebasing an Environment means that the next Deployment to the Environment will be based on the Deployment specified in the rebase rather than the last one in the Environment. The Deployment to rebase to can either be current or a previous Deployment. The Deployment can be from any Environment of the same Application.
Running code will only be affected on the next Deployment to the Environment.
Common use cases for rebasing an Environment:
-
Rollback: Rebasing to a previous Deployment in the current Environment and then Deploying without additional changes will execute a rollback to the previous Deployment state.
-
Clone: Rebasing to the current Deployment in a different Environment and then deploying without additional changes will clone all of the configuration of the other Environment into the current one. (NOTE: External Resources will not be cloned in the process - the current External Resources of the Environment will remain unchanged and will be used by the deployed Application in the Environment.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The Deployment ID to rebase to.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Rebase successful.
400
No Deployment with ID found in Application.
HumanitecErrorResponse
404
No Environment with ID found in Application and Organization.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/envs/{envId}
Get a specific Environment. (orgsOrgIdAppsAppIdEnvsEnvIdGet)
Gets a specific Environment in an Application.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "a.user@example.com",
"from_deploy" : {
"comment" : "Updated version of module-one to v0.3.1",
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "a.user@example.com",
"delta_id" : "df1ad41807b0390a9b0eaf8688e1f5baece9d764",
"env_id" : "my-env",
"from_id" : "42d4b302fd3c",
"id" : "67f1619a57d",
"status" : "in progress",
"status_changed_at" : "2020-05-22T14:59:01Z"
},
"id" : "feature-test",
"last_deploy" : {
"comment" : "Updated version of module-one to v0.3.1",
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "a.user@example.com",
"delta_id" : "df1ad41807b0390a9b0eaf8688e1f5baece9d764",
"env_id" : "my-env",
"from_id" : "42d4b302fd3c",
"id" : "67f1619a57d",
"status" : "in progress",
"status_changed_at" : "2020-05-22T14:59:01Z"
},
"name" : "Feature Test",
"type" : "development"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The Environment requested.
EnvironmentResponse
Example data
Content-Type: application/json
{}
404
No Environment with <code>id</code> in Application.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/envs/{envId}/resources
List Active Resources provisioned in an environment. (orgsOrgIdAppsAppIdEnvsEnvIdResourcesGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
Return type
Example data
Content-Type: application/json
[ {
"app_id" : "test-app",
"class" : "default",
"def_id" : "gcp-dev-postgres",
"deploy_id" : "172a1013b",
"env_id" : "gcp-dev",
"env_type" : "development",
"gu_res_id" : "7bd3966c9ff8eaa66c5cce855c03d715857c3440",
"org_id" : "test-org",
"res_id" : "modules.my-module.externals.my-db",
"resource" : {
"values" : {
"host" : "127.0.0.1",
"name" : "db_33c7ef9b_8d90-4c62_a1cf_0cdd30fd29a9",
"port" : 5432
}
},
"type" : "postgres",
"updated_at" : "2020-06-23T16:53:12Z"
}, {
"app_id" : "test-app",
"class" : "default",
"def_id" : "gcp-dev-postgres",
"deploy_id" : "172a1013b",
"env_id" : "gcp-dev",
"env_type" : "development",
"gu_res_id" : "7bd3966c9ff8eaa66c5cce855c03d715857c3440",
"org_id" : "test-org",
"res_id" : "modules.my-module.externals.my-db",
"resource" : {
"values" : {
"host" : "127.0.0.1",
"name" : "db_33c7ef9b_8d90-4c62_a1cf_0cdd30fd29a9",
"port" : 5432
}
},
"type" : "postgres",
"updated_at" : "2020-06-23T16:53:12Z"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty list of Active Resources.
500
Internal application error.
HumanitecErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/envs/{envId}/resources/graph
Lists the resource objects that hold the information needed to provision the resources specified in the request and the resources they depend on. (orgsOrgIdAppsAppIdEnvsEnvIdResourcesGraphPost)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Resources to provision.
Return type
Example data
Content-Type: application/json
[ {
"class" : "default",
"criteria_id" : "09876545321",
"def_id" : "dns-res-def",
"depends_on" : [ "ff09876545321" ],
"driver" : {
"secrets" : { },
"values" : {
"domain" : "my-domain"
}
},
"driver_type" : "humanitec/dns-aws-route53",
"guresid" : "1234567890ff",
"id" : "modules.sample-app.my-dns",
"resource" : null,
"resource_schema" : {
"properties" : {
"host" : {
"type" : "string"
}
},
"type" : "object"
},
"type" : "dns"
}, {
"class" : "default",
"criteria_id" : "09876545321",
"def_id" : "dns-res-def",
"depends_on" : [ "ff09876545321" ],
"driver" : {
"secrets" : { },
"values" : {
"domain" : "my-domain"
}
},
"driver_type" : "humanitec/dns-aws-route53",
"guresid" : "1234567890ff",
"id" : "modules.sample-app.my-dns",
"resource" : null,
"resource_schema" : {
"properties" : {
"host" : {
"type" : "string"
}
},
"type" : "object"
},
"type" : "dns"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A list of objects which hold information to provision resources, sorted according to resources provisioning order.
400
Request payload is not provided or is malformed.
HumanitecErrorResponse
500
Internal application error.
HumanitecErrorResponse
Up
delete /orgs/{orgId}/apps/{appId}/envs/{envId}/resources/{type}/{resId}
Delete Active Resources. (orgsOrgIdAppsAppIdEnvsEnvIdResourcesTypeResIdDelete)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
type (required)
Path Parameter — The Resource Type, may include a resource class: {type}.{class}.
resId (required)
Path Parameter — The Resource ID.
Responses
202
The resource has successfully been marked for deletion.
204
The resource deleted.
404
The requested resource could not be found.
409
Conflict when deleting resource.
Up
get /orgs/{orgId}/apps/{appId}/envs/{envId}/rules
List all Automation Rules in an Environment. (orgsOrgIdAppsAppIdEnvsEnvIdRulesGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
Return type
Example data
Content-Type: application/json
[ {
"active" : true,
"artefacts_filter" : [ "http://registry.org/sample-service" ],
"created_at" : "2021-07-22T14:53:27Z",
"created_by" : "0dbbdc88-b125-47f1-9a96-6c4c9d6ddc70",
"exclude_artefacts_filter" : false,
"exclude_images_filter" : false,
"id" : "923486d012f20324",
"images_filter" : [ "sample-service" ],
"match" : "^pr-[0-9]+-.*$",
"match_ref" : "^refs/heads/pr-[0-9]+-.*$",
"type" : "update",
"update_to" : "branch"
}, {
"active" : true,
"artefacts_filter" : [ "http://registry.org/sample-service" ],
"created_at" : "2021-07-22T14:53:27Z",
"created_by" : "0dbbdc88-b125-47f1-9a96-6c4c9d6ddc70",
"exclude_artefacts_filter" : false,
"exclude_images_filter" : false,
"id" : "923486d012f20324",
"images_filter" : [ "sample-service" ],
"match" : "^pr-[0-9]+-.*$",
"match_ref" : "^refs/heads/pr-[0-9]+-.*$",
"type" : "update",
"update_to" : "branch"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty array of Automation Rules
Example data
Content-Type: application/json
[{"active":true,"artefacts_filter":["http://registry.org/sample-service"],"created_at":"2021-07-22T14:53:27Z","created_by":"0dbbdc88-b125-47f1-9a96-6c4c9d6ddc70","exclude_artefacts_filter":false,"exclude_images_filter":false,"id":"923486d012f20324","images_filter":["sample-service"],"match":"^pr-[0-9]+-.*$","match_ref":"^refs/heads/pr-[0-9]+-.*$","type":"update","update_to":"branch"}]
500
Internal Server error.
Up
post /orgs/{orgId}/apps/{appId}/envs/{envId}/rules
Create a new Automation Rule for an Environment. (orgsOrgIdAppsAppIdEnvsEnvIdRulesPost)
Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if images_filter (deprecated) and artefacts_filter are used in the same payload. The same is true for exclude_images_filter (deprecated) and exclude_artefacts_filter. match and update_to are still supported but will trigger an error if combined with match_ref.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The definition of the Automation Rule.
example: {
"active" : true,
"artefacts_filter" : [ "http://registry.org/sample-service" ],
"exclude_artefacts_filter" : false,
"match_ref" : "^refs/heads/pr-[0-9]+-.*$",
"type" : "update"
}
Return type
Example data
Content-Type: application/json
{
"active" : true,
"artefacts_filter" : [ "http://registry.org/sample-service" ],
"created_at" : "2021-07-22T14:53:27Z",
"created_by" : "0dbbdc88-b125-47f1-9a96-6c4c9d6ddc70",
"exclude_artefacts_filter" : false,
"exclude_images_filter" : false,
"id" : "923486d012f20324",
"images_filter" : [ "sample-service" ],
"match" : "^pr-[0-9]+-.*$",
"match_ref" : "^refs/heads/pr-[0-9]+-.*$",
"type" : "update",
"update_to" : "branch"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
The AutomationRule
AutomationRuleResponse
400
The input was not a valid Automation Rule.
ErrorInfoResponse
422
The request body could not be processed.
Up
delete /orgs/{orgId}/apps/{appId}/envs/{envId}/rules/{ruleId}
Delete Automation Rule from an Environment. (orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdDelete)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
ruleId (required)
Path Parameter — The Automation Rule ID.
Responses
204
The AutomationRule was deleted.
404
There is no automation rule with the supplied ID.
Up
get /orgs/{orgId}/apps/{appId}/envs/{envId}/rules/{ruleId}
Get a specific Automation Rule for an Environment. (orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
ruleId (required)
Path Parameter — The Automation Rule ID.
Return type
Example data
Content-Type: application/json
{
"active" : true,
"artefacts_filter" : [ "http://registry.org/sample-service" ],
"created_at" : "2021-07-22T14:53:27Z",
"created_by" : "0dbbdc88-b125-47f1-9a96-6c4c9d6ddc70",
"exclude_artefacts_filter" : false,
"exclude_images_filter" : false,
"id" : "923486d012f20324",
"images_filter" : [ "sample-service" ],
"match" : "^pr-[0-9]+-.*$",
"match_ref" : "^refs/heads/pr-[0-9]+-.*$",
"type" : "update",
"update_to" : "branch"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The AutomationRule
AutomationRuleResponse
Example data
Content-Type: application/json
{"active":true,"artefacts_filter":["http://registry.org/sample-service"],"created_at":"2021-07-22T14:53:27Z","created_by":"0dbbdc88-b125-47f1-9a96-6c4c9d6ddc70","exclude_artefacts_filter":false,"exclude_images_filter":false,"id":"923486d012f20324","images_filter":["sample-service"],"match":"^pr-[0-9]+-.*$","match_ref":"^refs/heads/pr-[0-9]+-.*$","type":"update","update_to":"branch"}
404
There is no automation rule with the supplied ID.
Up
put /orgs/{orgId}/apps/{appId}/envs/{envId}/rules/{ruleId}
Update an existing Automation Rule for an Environment. (orgsOrgIdAppsAppIdEnvsEnvIdRulesRuleIdPut)
Items marked as deprecated are still supported (however not recommended) for use and are incompatible with properties of the latest api version. In particular an error is raised if images_filter (deprecated) and artefacts_filter are used in the same payload. The same is true for exclude_images_filter (deprecated) and exclude_artefacts_filter. match and update_to are still supported but will trigger an error if combined with match_ref.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
ruleId (required)
Path Parameter — The Automation Rule ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The definition of the Automation Rule.
example: {
"active" : true,
"artefacts_filter" : [ "http://registry.org/sample-service" ],
"exclude_artefacts_filter" : false,
"match_ref" : "^refs/heads/pr-[0-9]+-.*$",
"type" : "update"
}
Return type
Example data
Content-Type: application/json
{
"active" : true,
"artefacts_filter" : [ "http://registry.org/sample-service" ],
"created_at" : "2021-07-22T14:53:27Z",
"created_by" : "0dbbdc88-b125-47f1-9a96-6c4c9d6ddc70",
"exclude_artefacts_filter" : false,
"exclude_images_filter" : false,
"id" : "923486d012f20324",
"images_filter" : [ "sample-service" ],
"match" : "^pr-[0-9]+-.*$",
"match_ref" : "^refs/heads/pr-[0-9]+-.*$",
"type" : "update",
"update_to" : "branch"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The AutomationRule
AutomationRuleResponse
400
The input was not a valid Automation Rule.
ErrorInfoResponse
404
There is no automation rule with the supplied ID.
422
The request body could not be processed.
Up
get /orgs/{orgId}/apps/{appId}/envs/{envId}/runtime
Get Runtime information about the environment. (orgsOrgIdAppsAppIdEnvsEnvIdRuntimeGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
Return type
Example data
Content-Type: application/json
{
"namespace" : "namespace",
"modules" : {
"key" : {
"key" : {
"kind" : "kind",
"replicas" : 6,
"pods" : [ {
"phase" : "phase",
"containerStatuses" : [ "", "" ],
"podName" : "podName",
"revision" : 0,
"status" : "status"
}, {
"phase" : "phase",
"containerStatuses" : [ "", "" ],
"podName" : "podName",
"revision" : 0,
"status" : "status"
} ],
"message" : "message",
"revision" : 1,
"status" : "status"
}
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Runtime info returned.
RuntimeInfoResponse
400
Cluster not well configured or unreachable.
HumanitecErrorResponse
404
Environment not found.
HumanitecErrorResponse
Up
put /orgs/{orgId}/apps/{appId}/envs/{envId}/runtime/paused
Pause / Resume an environment. (orgsOrgIdAppsAppIdEnvsEnvIdRuntimePausedPut)
On pause requests, all the Kubernetes Deployment resources are scaled down to 0 replicas.
On resume requests, all the Kubernetes Deployment resources are scaled up to the number of replicas running before the environment was paused.
When an environment is paused, it is not possible to:
- Deploy the environment within Humanitec.
- Scale the number of replicas running of any workload.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — If the value is <code>true</code> the request is to pause an environment, if it is <code>false</code> is to resume an environment.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Success.
400
Missing or malformed input.
HumanitecErrorResponse
403
Forbidden (insufficient privileges to perform the action).
HumanitecErrorResponse
404
Environment not found.
HumanitecErrorResponse
Up
patch /orgs/{orgId}/apps/{appId}/envs/{envId}/runtime/replicas
Set number of replicas for an environment's modules. (orgsOrgIdAppsAppIdEnvsEnvIdRuntimeReplicasPatch)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — map of replicas by modules.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Success.
400
Missing or malformed input.
HumanitecErrorResponse
403
Forbidden (default cluster limitations or insufficient privileges to perform the action).
HumanitecErrorResponse
404
Environment not found.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/envs/{envId}/value-set-versions
List Value Set Versions in an Environment of an App (orgsOrgIdAppsAppIdEnvsEnvIdValueSetVersionsGet)
A new Value Set Version is created on every modification of a Value inside the an Environment of an App. In case this environment has no overrides the response is the same as the App level endpoint.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
Query parameters
key_changed (optional)
Query Parameter — (Optional) Return only value set version where the specified key changed
Return type
Example data
Content-Type: application/json
[ {
"result_of" : "app_value_create",
"updated_at" : "2020-06-22T09:37:23.523Z",
"change" : [ {
"op" : "op",
"path" : "path",
"value" : ""
}, {
"op" : "op",
"path" : "path",
"value" : ""
} ],
"source_value_set_version_id" : "source_value_set_version_id",
"values" : {
"key" : {
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}
},
"created_at" : "2020-06-22T09:37:23.523Z",
"comment" : "comment",
"id" : "id",
"created_by" : "created_by"
}, {
"result_of" : "app_value_create",
"updated_at" : "2020-06-22T09:37:23.523Z",
"change" : [ {
"op" : "op",
"path" : "path",
"value" : ""
}, {
"op" : "op",
"path" : "path",
"value" : ""
} ],
"source_value_set_version_id" : "source_value_set_version_id",
"values" : {
"key" : {
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}
},
"created_at" : "2020-06-22T09:37:23.523Z",
"comment" : "comment",
"id" : "id",
"created_by" : "created_by"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty list of ValueSetVersion.
Up
get /orgs/{orgId}/apps/{appId}/envs/{envId}/value-set-versions/{valueSetVersionId}
Get a single Value Set Version in an Environment of an App (orgsOrgIdAppsAppIdEnvsEnvIdValueSetVersionsValueSetVersionIdGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
valueSetVersionId (required)
Path Parameter — The ValueSetVersion ID. format: uuid
Return type
Example data
Content-Type: application/json
{
"result_of" : "app_value_create",
"updated_at" : "2020-06-22T09:37:23.523Z",
"change" : [ {
"op" : "op",
"path" : "path",
"value" : ""
}, {
"op" : "op",
"path" : "path",
"value" : ""
} ],
"source_value_set_version_id" : "source_value_set_version_id",
"values" : {
"key" : {
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}
},
"created_at" : "2020-06-22T09:37:23.523Z",
"comment" : "comment",
"id" : "id",
"created_by" : "created_by"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The requested ValueSetVersion
ValueSetVersionResponse
404
ValueSetVersion with <code>valueSetVersionId</code> in Environment.
HumanitecErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/envs/{envId}/value-set-versions/{valueSetVersionId}/purge/{key}
Purge the value of a specific Shared Value from the App Environment Version history. (orgsOrgIdAppsAppIdEnvsEnvIdValueSetVersionsValueSetVersionIdPurgeKeyPost)
Purging permanently removes the value of a specific Shared Value in an application. A purged value is no longer accessible, can't be restored and can't be used
by deployments referencing a Value Set Version where the value was present.
Learn more about purging in our docs.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
valueSetVersionId (required)
Path Parameter — The ValueSetVersion ID. format: uuid
key (required)
Path Parameter — Key of the value to be purged.
Consumes
This API call consumes the following media types via the request header:
Request body
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
key successfully purged
400
The specified key can't be purged in this version.
HumanitecErrorResponse
404
No ValueSetVersion with <code>valueSetVersionId</code> in App Environment.
HumanitecErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/envs/{envId}/value-set-versions/{valueSetVersionId}/restore/{key}
Restore a specific key from the Value Set Version in an Environment of an App (orgsOrgIdAppsAppIdEnvsEnvIdValueSetVersionsValueSetVersionIdRestoreKeyPost)
Restore the values of a single Shared Value in an Environment from a specific version.
Learn more about reverting in our docs.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
valueSetVersionId (required)
Path Parameter — The ValueSetVersion ID. format: uuid
key (required)
Path Parameter — Key of the value to be restored.
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result_of" : "app_value_create",
"updated_at" : "2020-06-22T09:37:23.523Z",
"change" : [ {
"op" : "op",
"path" : "path",
"value" : ""
}, {
"op" : "op",
"path" : "path",
"value" : ""
} ],
"source_value_set_version_id" : "source_value_set_version_id",
"values" : {
"key" : {
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}
},
"created_at" : "2020-06-22T09:37:23.523Z",
"comment" : "comment",
"id" : "id",
"created_by" : "created_by"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The resulting ValueSetVersion
ValueSetVersionResponse
400
Invalid request
HumanitecErrorResponse
404
No ValueSetVersion with <code>valueSetVersionId</code> in App Environment.
HumanitecErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/envs/{envId}/value-set-versions/{valueSetVersionId}/restore
Restore a Value Set Version in an Environment of an App (orgsOrgIdAppsAppIdEnvsEnvIdValueSetVersionsValueSetVersionIdRestorePost)
Restore the values of all Shared Values in an environment from a specific version. Keys not existing in the selected version are deleted.
Learn more about reverting in our docs.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
valueSetVersionId (required)
Path Parameter — The ValueSetVersion ID. format: uuid
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result_of" : "app_value_create",
"updated_at" : "2020-06-22T09:37:23.523Z",
"change" : [ {
"op" : "op",
"path" : "path",
"value" : ""
}, {
"op" : "op",
"path" : "path",
"value" : ""
} ],
"source_value_set_version_id" : "source_value_set_version_id",
"values" : {
"key" : {
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}
},
"created_at" : "2020-06-22T09:37:23.523Z",
"comment" : "comment",
"id" : "id",
"created_by" : "created_by"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The resulting ValueSetVersion
ValueSetVersionResponse
404
No ValueSetVersion with <code>valueSetVersionId</code> in App Environment.
HumanitecErrorResponse
Up
delete /orgs/{orgId}/apps/{appId}/envs/{envId}/values
Delete all Shared Value for an Environment (orgsOrgIdAppsAppIdEnvsEnvIdValuesDelete)
All Shared Values will be deleted. If the Shared Values are marked as a secret, they will also be deleted.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
Responses
204
Shared Value successfully deleted.
Up
get /orgs/{orgId}/apps/{appId}/envs/{envId}/values
List Shared Values in an Environment (orgsOrgIdAppsAppIdEnvsEnvIdValuesGet)
The returned values will be the base Application values with the Environment overrides where applicable. The source field will specify the level from which the value is from.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
Return type
Example data
Content-Type: application/json
[ {
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}, {
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty list of Values.
Up
delete /orgs/{orgId}/apps/{appId}/envs/{envId}/values/{key}
Delete Shared Value for an Environment (orgsOrgIdAppsAppIdEnvsEnvIdValuesKeyDelete)
The specified Shared Value will be permanently deleted. If the Shared Value is marked as a secret, it will also be permanently deleted.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
key (required)
Path Parameter — The key to update.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Shared Value successfully deleted.
400
Input not valid.
HumanitecErrorResponse
404
Shared Value does not exist.
HumanitecErrorResponse
Up
patch /orgs/{orgId}/apps/{appId}/envs/{envId}/values/{key}
Update Shared Value for an Environment (orgsOrgIdAppsAppIdEnvsEnvIdValuesKeyPatch)
Update the value or description of the Shared Value. Shared Values marked as secret can also be updated.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
key (required)
Path Parameter — The key to update.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — At least <code>value</code> or <code>description</code> must be supplied. All other fields will be ignored.
Return type
Example data
Content-Type: application/json
{
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Shared Value successfully updated.
ValueResponse
400
Input not valid.
HumanitecErrorResponse
404
Shared Value does not exist.
HumanitecErrorResponse
Up
put /orgs/{orgId}/apps/{appId}/envs/{envId}/values/{key}
Update Shared Value for an Environment (orgsOrgIdAppsAppIdEnvsEnvIdValuesKeyPut)
Update the value or description of the Shared Value. Shared Values marked as secret can also be updated.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
key (required)
Path Parameter — The key to update.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Both <code>value</code> and <code>description</code> must be supplied. All other fields will be ignored.
Return type
Example data
Content-Type: application/json
{
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Shared Value successfully updated.
ValueResponse
400
Input not valid.
HumanitecErrorResponse
404
Shared Value does not exist.
HumanitecErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/envs/{envId}/values
Create a Shared Value for an Environment (orgsOrgIdAppsAppIdEnvsEnvIdValuesPost)
The Shared Value created will only be available to the specific Environment.
If a Value is marked as a secret, it will be securely stored. It will not be possible to retrieve the value again through the API. The value of the secret can however be updated.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Definition of the new Shared Value.
Return type
Example data
Content-Type: application/json
{
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Shared Value successfully created.
ValueResponse
400
Input not valid.
HumanitecErrorResponse
409
Shared Value already exists.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/envs
List all Environments. (orgsOrgIdAppsAppIdEnvsGet)
Lists all of the Environments in the Application.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Return type
Example data
Content-Type: application/json
[ {
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "a.user@example.com",
"from_deploy" : {
"comment" : "Updated version of module-one to v0.3.1",
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "a.user@example.com",
"delta_id" : "df1ad41807b0390a9b0eaf8688e1f5baece9d764",
"env_id" : "my-env",
"from_id" : "42d4b302fd3c",
"id" : "67f1619a57d",
"status" : "in progress",
"status_changed_at" : "2020-05-22T14:59:01Z"
},
"id" : "feature-test",
"last_deploy" : {
"comment" : "Updated version of module-one to v0.3.1",
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "a.user@example.com",
"delta_id" : "df1ad41807b0390a9b0eaf8688e1f5baece9d764",
"env_id" : "my-env",
"from_id" : "42d4b302fd3c",
"id" : "67f1619a57d",
"status" : "in progress",
"status_changed_at" : "2020-05-22T14:59:01Z"
},
"name" : "Feature Test",
"type" : "development"
}, {
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "a.user@example.com",
"from_deploy" : {
"comment" : "Updated version of module-one to v0.3.1",
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "a.user@example.com",
"delta_id" : "df1ad41807b0390a9b0eaf8688e1f5baece9d764",
"env_id" : "my-env",
"from_id" : "42d4b302fd3c",
"id" : "67f1619a57d",
"status" : "in progress",
"status_changed_at" : "2020-05-22T14:59:01Z"
},
"id" : "feature-test",
"last_deploy" : {
"comment" : "Updated version of module-one to v0.3.1",
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "a.user@example.com",
"delta_id" : "df1ad41807b0390a9b0eaf8688e1f5baece9d764",
"env_id" : "my-env",
"from_id" : "42d4b302fd3c",
"id" : "67f1619a57d",
"status" : "in progress",
"status_changed_at" : "2020-05-22T14:59:01Z"
},
"name" : "Feature Test",
"type" : "development"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A list of Environments associated with an Application.
Example data
Content-Type: application/json
[{}]
Up
post /orgs/{orgId}/apps/{appId}/envs
Add a new Environment to an Application. (orgsOrgIdAppsAppIdEnvsPost)
Creates a new Environment of the specified Type and associates it with the Application specified by appId.
The Environment is also initialized to the current or past state of Deployment in another Environment. This ensures that every Environment is derived from a previously known state. This means it is not possible to create a new Environment for an Application until at least one Deployment has occurred. (The Deployment does not have to be successful.)
The Type of the Environment must be already defined in the Organization.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The ID, Name, Type, and Deployment the Environment will be derived from.
example: {
"from_deploy_id" : "e80db1a327208c1a",
"id" : "awesome-feature",
"name" : "Awesome Feature Dev",
"namespace" : "awesome-namespace",
"type" : "development"
}
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "a.user@example.com",
"from_deploy" : {
"comment" : "Updated version of module-one to v0.3.1",
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "a.user@example.com",
"delta_id" : "df1ad41807b0390a9b0eaf8688e1f5baece9d764",
"env_id" : "my-env",
"from_id" : "42d4b302fd3c",
"id" : "67f1619a57d",
"status" : "in progress",
"status_changed_at" : "2020-05-22T14:59:01Z"
},
"id" : "feature-test",
"last_deploy" : {
"comment" : "Updated version of module-one to v0.3.1",
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "a.user@example.com",
"delta_id" : "df1ad41807b0390a9b0eaf8688e1f5baece9d764",
"env_id" : "my-env",
"from_id" : "42d4b302fd3c",
"id" : "67f1619a57d",
"status" : "in progress",
"status_changed_at" : "2020-05-22T14:59:01Z"
},
"name" : "Feature Test",
"type" : "development"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The new Environment.
EnvironmentResponse
Example data
Content-Type: application/json
{}
400
The supplied <code>id</code> is an invalid ID or a required field is missing.
HumanitecErrorResponse
404
No Application with <code>id</code> in Organization.
HumanitecErrorResponse
409
The supplied <code>id</code> clashes with an existing Environment.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}
Get an existing Application (orgsOrgIdAppsAppIdGet)
Gets a specific Application in the specified Organization by ID.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-05-22T14:53:27Z",
"created_by" : "a.user@example.com",
"envs" : [ {
"id" : "my-env",
"name" : "My Environment"
} ],
"id" : "my-app",
"name" : "My Application"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The Application requested.
ApplicationResponse
Example data
Content-Type: application/json
{"created_at":"2020-06-15T09:32:03Z","created_by":"a-user@example.com","envs":{"id":"development","name":"Development","type":"development"},"id":"my-app","name":"My Awesome App"}
404
No Application with ID <code>appId</code> in Organization.
HumanitecErrorResponse
Up
delete /orgs/{orgId}/apps/{appId}/jobs
Deletes all Jobs for the Application (orgsOrgIdAppsAppIdJobsDelete)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Responses
204
Deleted successfully.
Up
get /orgs/{orgId}/apps/{appId}/runtime
Get Runtime information about specific environments. (orgsOrgIdAppsAppIdRuntimeGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Query parameters
id (optional)
Query Parameter — Filter environments by ID (required). Up to 5 ids can be supplied per request.
Return type
Example data
Content-Type: application/json
[ {
"paused" : true,
"id" : "id",
"error" : "error",
"status" : "status"
}, {
"paused" : true,
"id" : "id",
"error" : "error",
"status" : "status"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A list of the RuntimeInfo of the environments specified by the id parameter.
Example data
Content-Type: application/json
[{"id":"development","paused":true,"status":"Success"},{"id":"staging","paused":false,"status":"Warning"},{"error":"Environment my-org/my-app/not-existing-env does not exist","id":"not-existing-env","paused":false}]
400
Bad Request.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/sets/{setId}/diff/{sourceSetId}
Get the difference between 2 Deployment Sets (orgsOrgIdAppsAppIdSetsSetIdDiffSourceSetIdGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
setId (required)
Path Parameter — ID of the Deployment Set.
sourceSetId (required)
Path Parameter — ID of the Deployment Set to diff against.
Return type
Example data
Content-Type: application/json
{
"modules" : {
"add" : {
"redis-cache" : {
"profile" : "humanitec/redis"
}
},
"remove" : [ "simple-service" ],
"update" : {
"module-one" : [ {
"op" : "replace",
"path" : "/spec/containers/core-service/variables/EXAMPLE",
"value" : "New Value"
} ]
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A Deployment Delta which if applied to the Set with ID <code>sourceSetId</code> gives the Set with ID <code>setId</code>.
PlainDeltaResponse
404
No Deployment Set with ID <code>setId</code> or <code>sourceSetId</code> found in Application.
String
Up
get /orgs/{orgId}/apps/{appId}/sets/{setId}
Get a Deployment Set (orgsOrgIdAppsAppIdSetsSetIdGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
setId (required)
Path Parameter — ID of the Deployment Set.
Query parameters
diff (optional)
Query Parameter — ID of the Deployment Set to compared against.
Return type
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The Requested Deployment Set.
inline_response_200_1
404
No Deployment Set with ID <code>setId</code> found in Application.
String
Up
post /orgs/{orgId}/apps/{appId}/sets/{setId}
Apply a Deployment Delta to a Deployment Set (orgsOrgIdAppsAppIdSetsSetIdPost)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
setId (required)
Path Parameter — ID of the Deployment Set.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — <p>The Delta to apply to the Set.</p>
<p>NOTE: The <code>id</code> parameter is ignored if provided. The request body should be the full Delta.</p>
example: {
"modules" : {
"remove" : [ "module-one" ]
}
}
Return type
String
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A Deployment Delta which if applied to the Set with ID <code>sourceSetId</code> gives the Set with ID <code>setId</code>.
String
400
Deployment Delta is incompatible with the Deployment Set specified by <code>setId</code>.
HumanitecErrorResponse
404
No Deployment Set with ID <code>setId</code> found in Application.
String
Up
get /orgs/{orgId}/apps/{appId}/users
List Users with roles in an App (orgsOrgIdAppsAppIdUsersGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Return type
Example data
Content-Type: application/json
[ {
"role" : "manager",
"user" : "61048226-642c-438e-974f-ce5c013d94f8",
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "730c1f96-8ee5-4bff-8c22-898e0530b924",
"invite" : "accepted",
"name" : "Jo Trigg",
"type" : "user"
}, {
"role" : "manager",
"user" : "61048226-642c-438e-974f-ce5c013d94f8",
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "730c1f96-8ee5-4bff-8c22-898e0530b924",
"invite" : "accepted",
"name" : "Jo Trigg",
"type" : "user"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A list of Users and the roles they hold.
404
Object does not exist.
Up
post /orgs/{orgId}/apps/{appId}/users
Adds a User to an Application with a Role (orgsOrgIdAppsAppIdUsersPost)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The user ID and the role
example: {
"id" : "61048226-642c-438e-974f-ce5c013d94f8",
"role" : "manager"
}
Return type
Example data
Content-Type: application/json
{
"role" : "manager",
"user" : "61048226-642c-438e-974f-ce5c013d94f8",
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "730c1f96-8ee5-4bff-8c22-898e0530b924",
"invite" : "accepted",
"name" : "Jo Trigg",
"type" : "user"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The user ID and associated role.
UserRoleResponse
400
The request was invalid or the payload malformed.
HumanitecErrorResponse
404
The specified Application was not found.
422
The request body was not parseable.
Up
delete /orgs/{orgId}/apps/{appId}/users/{userId}
Remove the role of a User on an Application (orgsOrgIdAppsAppIdUsersUserIdDelete)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
userId (required)
Path Parameter — The User ID
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Role of the user successfully deleted.
400
The request was invalid or the payload malformed.
HumanitecErrorResponse
404
Object does not exist.
Up
get /orgs/{orgId}/apps/{appId}/users/{userId}
Get the role of a User on an Application (orgsOrgIdAppsAppIdUsersUserIdGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
userId (required)
Path Parameter — The User ID
Return type
Example data
Content-Type: application/json
{
"role" : "manager",
"user" : "61048226-642c-438e-974f-ce5c013d94f8",
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "730c1f96-8ee5-4bff-8c22-898e0530b924",
"invite" : "accepted",
"name" : "Jo Trigg",
"type" : "user"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The information on the user.
UserRoleResponse
400
The request was invalid or the payload malformed.
HumanitecErrorResponse
404
Object does not exist.
Up
patch /orgs/{orgId}/apps/{appId}/users/{userId}
Update the role of a User on an Application (orgsOrgIdAppsAppIdUsersUserIdPatch)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
userId (required)
Path Parameter — The User ID
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The new user role
Return type
Example data
Content-Type: application/json
{
"role" : "manager",
"user" : "61048226-642c-438e-974f-ce5c013d94f8",
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "730c1f96-8ee5-4bff-8c22-898e0530b924",
"invite" : "accepted",
"name" : "Jo Trigg",
"type" : "user"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The information on the user.
UserRoleResponse
400
The request was invalid or the payload malformed.
HumanitecErrorResponse
404
Object does not exist.
Up
get /orgs/{orgId}/apps/{appId}/value-set-versions
List Value Set Versions in the App (orgsOrgIdAppsAppIdValueSetVersionsGet)
A new Value Set Version is created on every modification of a Value inside the app.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Query parameters
key_changed (optional)
Query Parameter — (Optional) Return only value set version where the specified key changed
Return type
Example data
Content-Type: application/json
[ {
"result_of" : "app_value_create",
"updated_at" : "2020-06-22T09:37:23.523Z",
"change" : [ {
"op" : "op",
"path" : "path",
"value" : ""
}, {
"op" : "op",
"path" : "path",
"value" : ""
} ],
"source_value_set_version_id" : "source_value_set_version_id",
"values" : {
"key" : {
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}
},
"created_at" : "2020-06-22T09:37:23.523Z",
"comment" : "comment",
"id" : "id",
"created_by" : "created_by"
}, {
"result_of" : "app_value_create",
"updated_at" : "2020-06-22T09:37:23.523Z",
"change" : [ {
"op" : "op",
"path" : "path",
"value" : ""
}, {
"op" : "op",
"path" : "path",
"value" : ""
} ],
"source_value_set_version_id" : "source_value_set_version_id",
"values" : {
"key" : {
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}
},
"created_at" : "2020-06-22T09:37:23.523Z",
"comment" : "comment",
"id" : "id",
"created_by" : "created_by"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty list of ValueSetVersion.
Up
get /orgs/{orgId}/apps/{appId}/value-set-versions/{valueSetVersionId}
Get a single Value Set Version from the App (orgsOrgIdAppsAppIdValueSetVersionsValueSetVersionIdGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
valueSetVersionId (required)
Path Parameter — The ValueSetVersion ID. format: uuid
Return type
Example data
Content-Type: application/json
{
"result_of" : "app_value_create",
"updated_at" : "2020-06-22T09:37:23.523Z",
"change" : [ {
"op" : "op",
"path" : "path",
"value" : ""
}, {
"op" : "op",
"path" : "path",
"value" : ""
} ],
"source_value_set_version_id" : "source_value_set_version_id",
"values" : {
"key" : {
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}
},
"created_at" : "2020-06-22T09:37:23.523Z",
"comment" : "comment",
"id" : "id",
"created_by" : "created_by"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The requested ValueSetVersion
ValueSetVersionResponse
404
ValueSetVersion with <code>valueSetVersionId</code> in App.
HumanitecErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/value-set-versions/{valueSetVersionId}/purge/{key}
Purge the value of a specific Shared Value from the App Version history. (orgsOrgIdAppsAppIdValueSetVersionsValueSetVersionIdPurgeKeyPost)
Purging permanently removes the value of a specific Shared Value in an Application. A purged value is no longer accessible, can't be restored and can't be used
by deployments referencing a Value Set Version where the value was present.
Learn more about purging in our docs.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
valueSetVersionId (required)
Path Parameter — The ValueSetVersion ID. format: uuid
key (required)
Path Parameter — Key of the value to be purged.
Consumes
This API call consumes the following media types via the request header:
Request body
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
key successfully purged
400
The specified key can't be purged in this version.
HumanitecErrorResponse
404
No ValueSetVersion with <code>valueSetVersionId</code> in App.
HumanitecErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/value-set-versions/{valueSetVersionId}/restore/{key}
Restore a specific key from the Value Set Version in an App (orgsOrgIdAppsAppIdValueSetVersionsValueSetVersionIdRestoreKeyPost)
Restore the values of a single Shared Value in an application from a specific version.
Learn more about reverting in our docs.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
valueSetVersionId (required)
Path Parameter — The ValueSetVersion ID. format: uuid
key (required)
Path Parameter — Key of the value to be restored.
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result_of" : "app_value_create",
"updated_at" : "2020-06-22T09:37:23.523Z",
"change" : [ {
"op" : "op",
"path" : "path",
"value" : ""
}, {
"op" : "op",
"path" : "path",
"value" : ""
} ],
"source_value_set_version_id" : "source_value_set_version_id",
"values" : {
"key" : {
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}
},
"created_at" : "2020-06-22T09:37:23.523Z",
"comment" : "comment",
"id" : "id",
"created_by" : "created_by"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The resulting ValueSetVersion
ValueSetVersionResponse
400
Invalid request
HumanitecErrorResponse
404
No ValueSetVersion with <code>valueSetVersionId</code> in App.
HumanitecErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/value-set-versions/{valueSetVersionId}/restore
Restore a Value Set Version in an App (orgsOrgIdAppsAppIdValueSetVersionsValueSetVersionIdRestorePost)
Restore the values of all Shared Values in an application from a specific version. Keys not existing in the selected version are deleted.
Learn more about reverting in our docs.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
valueSetVersionId (required)
Path Parameter — The ValueSetVersion ID. format: uuid
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result_of" : "app_value_create",
"updated_at" : "2020-06-22T09:37:23.523Z",
"change" : [ {
"op" : "op",
"path" : "path",
"value" : ""
}, {
"op" : "op",
"path" : "path",
"value" : ""
} ],
"source_value_set_version_id" : "source_value_set_version_id",
"values" : {
"key" : {
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}
},
"created_at" : "2020-06-22T09:37:23.523Z",
"comment" : "comment",
"id" : "id",
"created_by" : "created_by"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The resulting ValueSetVersion
ValueSetVersionResponse
404
No ValueSetVersion with <code>valueSetVersionId</code> in App.
HumanitecErrorResponse
Up
delete /orgs/{orgId}/apps/{appId}/values
Delete all Shared Value for an App (orgsOrgIdAppsAppIdValuesDelete)
All Shared Values will be deleted. If the Shared Values are marked as a secret, they will also be deleted.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Responses
204
Shared Values successfully deleted.
Up
get /orgs/{orgId}/apps/{appId}/values
List Shared Values in an Application (orgsOrgIdAppsAppIdValuesGet)
The returned values will be the "base" values for the Application. The overridden value for the Environment can be retrieved via the /orgs/{orgId}/apps/{appId}/envs/{envId}/values endpoint.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Return type
Example data
Content-Type: application/json
[ {
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}, {
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty list of Values.
Up
delete /orgs/{orgId}/apps/{appId}/values/{key}
Delete Shared Value for an Application (orgsOrgIdAppsAppIdValuesKeyDelete)
The specified Shared Value will be permanently deleted. If the Shared Value is marked as a secret, it will also be permanently deleted.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
key (required)
Path Parameter — The key to update.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Shared Value successfully deleted.
400
Input not valid.
HumanitecErrorResponse
404
Shared Value does not exist.
HumanitecErrorResponse
Up
patch /orgs/{orgId}/apps/{appId}/values/{key}
Update Shared Value for an Application (orgsOrgIdAppsAppIdValuesKeyPatch)
Update the value or description of the Shared Value. Shared Values marked as secret can also be updated.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
key (required)
Path Parameter — The key to update.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — At least <code>value</code> or <code>description</code> must be supplied. All other fields will be ignored.
Return type
Example data
Content-Type: application/json
{
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Shared Value successfully updated.
ValueResponse
400
Input not valid.
HumanitecErrorResponse
404
Shared Value does not exist.
HumanitecErrorResponse
Up
put /orgs/{orgId}/apps/{appId}/values/{key}
Update Shared Value for an Application (orgsOrgIdAppsAppIdValuesKeyPut)
Update the value or description of the Shared Value. Shared Values marked as secret can also be updated.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
key (required)
Path Parameter — The key to update.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Both <code>value</code> and <code>description</code> must be supplied. All other fields will be ignored.
Return type
Example data
Content-Type: application/json
{
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Shared Value successfully updated.
ValueResponse
400
Input not valid.
HumanitecErrorResponse
404
Shared Value does not exist.
HumanitecErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/values
Create a Shared Value for an Application (orgsOrgIdAppsAppIdValuesPost)
The Shared Value created will be available to all Environments in that Application.
If a Value is marked as a secret, it will be securely stored. It will not be possible to retrieve the value again through the API. The value of the secret can however be updated.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Definition of the new Shared Value.
Return type
Example data
Content-Type: application/json
{
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Shared Value successfully created.
ValueResponse
400
Input not valid.
HumanitecErrorResponse
409
Shared Value already exists.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/webhooks
List Webhooks (orgsOrgIdAppsAppIdWebhooksGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Return type
Example data
Content-Type: application/json
[ {
"headers" : {
"key" : ""
},
"created_at" : "2020-06-22T09:37:23.523Z",
"disabled" : true,
"id" : "id",
"triggers" : [ {
"scope" : "scope",
"type" : "type"
}, {
"scope" : "scope",
"type" : "type"
} ],
"created_by" : "created_by",
"url" : "url"
}, {
"headers" : {
"key" : ""
},
"created_at" : "2020-06-22T09:37:23.523Z",
"disabled" : true,
"id" : "id",
"triggers" : [ {
"scope" : "scope",
"type" : "type"
}, {
"scope" : "scope",
"type" : "type"
} ],
"created_by" : "created_by",
"url" : "url"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A list of Webhooks.
Up
delete /orgs/{orgId}/apps/{appId}/webhooks/{jobId}
Delete a Webhook (orgsOrgIdAppsAppIdWebhooksJobIdDelete)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
jobId (required)
Path Parameter — The Webhook ID.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Deleted successfully
404
The requested webhook not found.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/webhooks/{jobId}
Get a Webhook (orgsOrgIdAppsAppIdWebhooksJobIdGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
jobId (required)
Path Parameter — The Webhook ID.
Return type
Example data
Content-Type: application/json
{
"headers" : {
"key" : ""
},
"created_at" : "2020-06-22T09:37:23.523Z",
"disabled" : true,
"id" : "id",
"triggers" : [ {
"scope" : "scope",
"type" : "type"
}, {
"scope" : "scope",
"type" : "type"
} ],
"created_by" : "created_by",
"url" : "url"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The requested webhook.
WebhookResponse
404
The requested webhook not found.
HumanitecErrorResponse
Up
patch /orgs/{orgId}/apps/{appId}/webhooks/{jobId}
Update a Webhook (orgsOrgIdAppsAppIdWebhooksJobIdPatch)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
jobId (required)
Path Parameter — The Webhook ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"headers" : {
"key" : ""
},
"disabled" : true,
"triggers" : [ {
"scope" : "scope",
"type" : "type"
}, {
"scope" : "scope",
"type" : "type"
} ],
"url" : "url"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Updated successfully, return the webhook
WebhookUpdateResponse
400
Bad request
HumanitecErrorResponse
404
The requested webhook not found.
HumanitecErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/webhooks
Create a new Webhook (orgsOrgIdAppsAppIdWebhooksPost)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"headers" : {
"key" : ""
},
"created_at" : "2020-06-22T09:37:23.523Z",
"disabled" : true,
"id" : "id",
"triggers" : [ {
"scope" : "scope",
"type" : "type"
}, {
"scope" : "scope",
"type" : "type"
} ],
"created_by" : "created_by",
"url" : "url"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
A created webhook.
WebhookResponse
400
Some of the values supplied are invalid.
HumanitecErrorResponse
409
The supplied <code>id</code> clashes with an existing Job.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps
List all Applications in an Organization. (orgsOrgIdAppsGet)
Listing or lists of all Applications that exist within a specific Organization.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Return type
Example data
Content-Type: application/json
[ {
"created_at" : "2020-05-22T14:53:27Z",
"created_by" : "a.user@example.com",
"envs" : [ {
"id" : "my-env",
"name" : "My Environment"
} ],
"id" : "my-app",
"name" : "My Application"
}, {
"created_at" : "2020-05-22T14:53:27Z",
"created_by" : "a.user@example.com",
"envs" : [ {
"id" : "my-env",
"name" : "My Environment"
} ],
"id" : "my-app",
"name" : "My Application"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Possibly empty list of Applications.
Example data
Content-Type: application/json
[{"created_at":"2020-06-15T09:32:03Z","created_by":"a-user@example.com","envs":{"id":"development","name":"Development","type":"development"},"id":"my-app","name":"My Awesome App"}]
Up
post /orgs/{orgId}/apps
Add a new Application to an Organization (orgsOrgIdAppsPost)
Creates a new Application, then adds it to the specified Organization.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The request ID, Human-friendly name and environment of the Application.
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-05-22T14:53:27Z",
"created_by" : "a.user@example.com",
"envs" : [ {
"id" : "my-env",
"name" : "My Environment"
} ],
"id" : "my-app",
"name" : "My Application"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
The Application requested.
ApplicationResponse
Example data
Content-Type: application/json
{"created_at":"2020-06-15T09:32:03Z","created_by":"a-user@example.com","envs":{"id":"development","name":"Development","type":"development"},"id":"my-app","name":"My Awesome App"}
400
The request body was unparseable.
HumanitecErrorResponse
401
The Authorization header was not present or invalid.
HumanitecErrorResponse
409
The supplied <code>id</code> clashes with an existing Application.
HumanitecErrorResponse
Up
get /orgs/{orgId}/artefact-versions/{artefactVersionId}
Get an Artefacts Versions. (orgsOrgIdArtefactVersionsArtefactVersionIdGet)
Returns a specific Artefact Version.
Path parameters
orgId (required)
Path Parameter — The organization ID.
artefactVersionId (required)
Path Parameter — The Artefact Version ID.
Return type
Example data
Content-Type: application/json
{
"archived" : false,
"artefact_id" : "123e4567-e89b-12d3-a456-426614174000",
"commit" : "060c3d6530a881afb808f105f36af25e1ad1b2f3",
"created_at" : "2020-05-25T17:41:57Z",
"created_by" : "987654321",
"digest" : "sha256:8414aa82208bc4c2761dc149df67e25c6b8a9380e5d8c4e7b5c84ca2d04bb244",
"id" : "b4c9e4e2-b3e5-11ec-b909-0242ac120002",
"name" : "registry.humanitec.io/my-org/my-service",
"ref" : "refs/heads/main",
"updated_at" : "2020-06-25T17:41:57Z",
"updated_by" : "123456789",
"version" : "1.2.6"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
An Artefact Version.
ArtefactVersionResponse
Example data
Content-Type: application/json
{"archived":false,"artefact_id":"da97af75-2e7c-4ef3-bec0-755ce1e8dd29","commit":"a5cf4ab4b8a958005202916bf3bb627ebd62a11f","created_at":"2020-06-10T10:00:00Z","created_by":"1234567789","digest":"sha256:8414aa82208bc4c2761dc149df67e25c6b8a9380e5d8c4e7b5c84ca2d04bb244","id":"662b80db-cc71-40cf-b601-08d57983f6e4","name":"registry.humanitec.io/public/sample-app","ref":"refs/heads/master","updated_at":"2020-06-12T10:00:00Z","updated_by":"987654321","version":"1.3.0"}
400
Malformed Artefact Version ID.
HumanitecErrorResponse
404
Artefact Version not found.
HumanitecErrorResponse
Up
get /orgs/{orgId}/artefact-versions
List all Artefacts Versions. (orgsOrgIdArtefactVersionsGet)
Returns the Artefact Versions registered with your organization. If no elements are found, an empty list is returned.
Path parameters
orgId (required)
Path Parameter — The organization ID.
Query parameters
name (optional)
Query Parameter — (Optional) Filter Artefact Versions by name.
reference (optional)
Query Parameter — (Optional) Filter Artefact Versions by the reference to a Version of the same Artefact. This cannot be used together with <code>name</code>.
archived (optional)
Query Parameter — (Optional) Filter for non-archived Artefact Versions. If no filter is defined only non-archived Artefact Versions are returned, if the filter is true both archived and non-archived Versions are returned.
Return type
Example data
Content-Type: application/json
[ {
"archived" : false,
"artefact_id" : "123e4567-e89b-12d3-a456-426614174000",
"commit" : "060c3d6530a881afb808f105f36af25e1ad1b2f3",
"created_at" : "2020-05-25T17:41:57Z",
"created_by" : "987654321",
"digest" : "sha256:8414aa82208bc4c2761dc149df67e25c6b8a9380e5d8c4e7b5c84ca2d04bb244",
"id" : "b4c9e4e2-b3e5-11ec-b909-0242ac120002",
"name" : "registry.humanitec.io/my-org/my-service",
"ref" : "refs/heads/main",
"updated_at" : "2020-06-25T17:41:57Z",
"updated_by" : "123456789",
"version" : "1.2.6"
}, {
"archived" : false,
"artefact_id" : "123e4567-e89b-12d3-a456-426614174000",
"commit" : "060c3d6530a881afb808f105f36af25e1ad1b2f3",
"created_at" : "2020-05-25T17:41:57Z",
"created_by" : "987654321",
"digest" : "sha256:8414aa82208bc4c2761dc149df67e25c6b8a9380e5d8c4e7b5c84ca2d04bb244",
"id" : "b4c9e4e2-b3e5-11ec-b909-0242ac120002",
"name" : "registry.humanitec.io/my-org/my-service",
"ref" : "refs/heads/main",
"updated_at" : "2020-06-25T17:41:57Z",
"updated_by" : "123456789",
"version" : "1.2.6"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A list of Artefact Versions registered with your organization.
Example data
Content-Type: application/json
[{"archived":false,"artefact_id":"da97af75-2e7c-4ef3-bec0-755ce1e8dd29","commit":"a5cf4ab4b8a958005202916bf3bb627ebd62a11f","created_at":"2020-06-10T10:00:00Z","created_by":"1234567789","digest":"sha256:8414aa82208bc4c2761dc149df67e25c6b8a9380e5d8c4e7b5c84ca2d04bb244","id":"662b80db-cc71-40cf-b601-08d57983f6e4","name":"registry.humanitec.io/public/sample-app","ref":"refs/heads/master","updated_at":"2020-06-12T10:00:00Z","updated_by":"987654321","version":"1.3.0"},{"archived":false,"artefact_id":"8a76aff7-cc3d-4d06-994d-4825bce80529","commit":"a5cf4ab4b8a958005202916bf3bb627ebd62a11f","created_at":"2020-06-10T10:00:00Z","created_by":"1234567789","digest":"","id":"abf214a0-5de0-430d-a0b4-bb9871567ade","name":"registry.humanitec.io/public/sample-service","ref":"refs/heads/master","updated_at":"2020-06-13T10:00:00Z","updated_by":"987654321","version":"1.2.0"}]
400
Bad request.
HumanitecErrorResponse
Up
post /orgs/{orgId}/artefact-versions
Register a new Artefact Version with your organization. (orgsOrgIdArtefactVersionsPost)
Path parameters
orgId (required)
Path Parameter — The organization ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The data needed to register a new Artefact Version within the organization.
Query parameters
vcs (optional)
Query Parameter — (Optional) Which version control system the version comes from. Default value is "git". If this parameter is not supplied or its value is "git", the provided ref, if not empty, is checked to ensure that it has the prefix "refs/".
Return type
Example data
Content-Type: application/json
{
"archived" : false,
"artefact_id" : "123e4567-e89b-12d3-a456-426614174000",
"commit" : "060c3d6530a881afb808f105f36af25e1ad1b2f3",
"created_at" : "2020-05-25T17:41:57Z",
"created_by" : "987654321",
"digest" : "sha256:8414aa82208bc4c2761dc149df67e25c6b8a9380e5d8c4e7b5c84ca2d04bb244",
"id" : "b4c9e4e2-b3e5-11ec-b909-0242ac120002",
"name" : "registry.humanitec.io/my-org/my-service",
"ref" : "refs/heads/main",
"updated_at" : "2020-06-25T17:41:57Z",
"updated_by" : "123456789",
"version" : "1.2.6"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
An Artefact Version.
ArtefactVersionResponse
400
Either one or more request body parameters are missing or invalid, or the requested payload is not provided or malformed.
HumanitecErrorResponse
401
Request unauthorised.
HumanitecErrorResponse
Up
delete /orgs/{orgId}/artefacts/{artefactId}
Delete Artefact and all related Artefact Versions (orgsOrgIdArtefactsArtefactIdDelete)
The specified Artefact and its Artefact Versions will be permanently deleted. Only Administrators can delete an Artefact.
Path parameters
orgId (required)
Path Parameter — The organization ID.
artefactId (required)
Path Parameter — The Artefact ID.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Artefact and related Artefact Versions successfully deleted.
403
Request forbidden. This action can only be performed by users holding the Administrator role. It is not possible to delete a built-in artefact.
HumanitecErrorResponse
404
Artefact not found within your organization.
HumanitecErrorResponse
Up
get /orgs/{orgId}/artefacts/{artefactId}/versions
List all Artefact Versions of an Artefact. (orgsOrgIdArtefactsArtefactIdVersionsGet)
Returns the Artefact Versions of a specified Artefact registered with your organization. If no elements are found, an empty list is returned.
Path parameters
orgId (required)
Path Parameter — The organization ID.
artefactId (required)
Path Parameter — The Artefact ID.
Query parameters
archived (optional)
Query Parameter — (Optional) Filter for non-archived Artefact Versions. If no filter is defined only non-archived Artefact Versions are returned, if the filter is true both archived and non-archived Versions are returned.
reference (optional)
Query Parameter — (Optional) Filter Artefact Versions by by name including a version or digest.
limit (optional)
Query Parameter — (Optional) Limit the number of versions returned by the endpoint.
Return type
Example data
Content-Type: application/json
[ {
"archived" : false,
"artefact_id" : "123e4567-e89b-12d3-a456-426614174000",
"commit" : "060c3d6530a881afb808f105f36af25e1ad1b2f3",
"created_at" : "2020-05-25T17:41:57Z",
"created_by" : "987654321",
"digest" : "sha256:8414aa82208bc4c2761dc149df67e25c6b8a9380e5d8c4e7b5c84ca2d04bb244",
"id" : "b4c9e4e2-b3e5-11ec-b909-0242ac120002",
"name" : "registry.humanitec.io/my-org/my-service",
"ref" : "refs/heads/main",
"updated_at" : "2020-06-25T17:41:57Z",
"updated_by" : "123456789",
"version" : "1.2.6"
}, {
"archived" : false,
"artefact_id" : "123e4567-e89b-12d3-a456-426614174000",
"commit" : "060c3d6530a881afb808f105f36af25e1ad1b2f3",
"created_at" : "2020-05-25T17:41:57Z",
"created_by" : "987654321",
"digest" : "sha256:8414aa82208bc4c2761dc149df67e25c6b8a9380e5d8c4e7b5c84ca2d04bb244",
"id" : "b4c9e4e2-b3e5-11ec-b909-0242ac120002",
"name" : "registry.humanitec.io/my-org/my-service",
"ref" : "refs/heads/main",
"updated_at" : "2020-06-25T17:41:57Z",
"updated_by" : "123456789",
"version" : "1.2.6"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Returns all Versions of the specified Artefact.
Example data
Content-Type: application/json
[{"archived":false,"artefact_id":"da97af75-2e7c-4ef3-bec0-755ce1e8dd29","commit":"a5cf4ab4b8a958005202916bf3bb627ebd62a11f","created_at":"2020-06-10T10:00:00Z","created_by":"1234567789","digest":"sha256:8414aa82208bc4c2761dc149df67e25c6b8a9380e5d8c4e7b5c84ca2d04bb244","id":"662b80db-cc71-40cf-b601-08d57983f6e4","name":"registry.humanitec.io/public/sample-app","ref":"refs/heads/master","updated_at":"2020-06-12T10:00:00Z","updated_by":"987654321","version":"1.3.0"},{"archived":false,"artefact_id":"da97af75-2e7c-4ef3-bec0-755ce1e8dd29","commit":"a5cf4ab4b8a958005202916bf3bb627ebd62a11f","created_at":"2020-06-10T10:00:00Z","created_by":"1234567789","digest":"","id":"abf214a0-5de0-430d-a0b4-bb9871567ade","name":"registry.humanitec.io/public/sample-app","ref":"refs/heads/master","updated_at":"2020-06-13T10:00:00Z","updated_by":"987654321","version":"1.2.0"}]
400
Invalid inputs provided.
HumanitecErrorResponse
404
No Artefact with the supplied ID <code>artefactID</code> has been found within the organization.
HumanitecErrorResponse
Up
patch /orgs/{orgId}/artefacts/{artefactId}/versions/{versionId}
Update Version of an Artefact. (orgsOrgIdArtefactsArtefactIdVersionsVersionIdPatch)
Update the version of a specified Artefact registered with your organization".
Path parameters
orgId (required)
Path Parameter — The organization ID.
artefactId (required)
Path Parameter — The Artefact ID.
versionId (required)
Path Parameter — The Version ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The Artefact Version Update Request. Only the field <code>archive</code> can be updated.
Return type
Example data
Content-Type: application/json
{
"archived" : false,
"artefact_id" : "123e4567-e89b-12d3-a456-426614174000",
"commit" : "060c3d6530a881afb808f105f36af25e1ad1b2f3",
"created_at" : "2020-05-25T17:41:57Z",
"created_by" : "987654321",
"digest" : "sha256:8414aa82208bc4c2761dc149df67e25c6b8a9380e5d8c4e7b5c84ca2d04bb244",
"id" : "b4c9e4e2-b3e5-11ec-b909-0242ac120002",
"name" : "registry.humanitec.io/my-org/my-service",
"ref" : "refs/heads/main",
"updated_at" : "2020-06-25T17:41:57Z",
"updated_by" : "123456789",
"version" : "1.2.6"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The updated Artefact Version.
ArtefactVersionResponse
400
One or more request parameters are missing or invalid, or the requested payload is not provided or malformed.
HumanitecErrorResponse
401
Request unauthorised.
HumanitecErrorResponse
403
Update requested on a version of a builtin artefact.
HumanitecErrorResponse
404
No Artefact with the supplied artefactId or no Artefact Version with the supplied versionId have been found within the organization.
HumanitecErrorResponse
Up
get /orgs/{orgId}/artefacts
List all Artefacts. (orgsOrgIdArtefactsGet)
Returns the Artefacts registered with your organization. If no elements are found, an empty list is returned.
Path parameters
orgId (required)
Path Parameter — The organization ID.
Query parameters
type (optional)
Query Parameter — (Optional) Filter Artefacts by type.
name (optional)
Query Parameter — (Optional) Filter Artefacts by name.
Return type
Example data
Content-Type: application/json
[ {
"created_at" : "2020-05-12T16:12:13Z",
"created_by" : "123456789",
"id" : "123e4567-e89b-12d3-a456-426614174000",
"name" : "registry.humanitec.io/my-org/my-service",
"type" : "container",
"updated_at" : "2020-06-12T16:12:13Z",
"updated_by" : "987654321"
}, {
"created_at" : "2020-05-12T16:12:13Z",
"created_by" : "123456789",
"id" : "123e4567-e89b-12d3-a456-426614174000",
"name" : "registry.humanitec.io/my-org/my-service",
"type" : "container",
"updated_at" : "2020-06-12T16:12:13Z",
"updated_by" : "987654321"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The list of Artefacts within the organization.
Example data
Content-Type: application/json
[{"created_at":"2020-06-10T10:00:00Z","created_by":"1234567789","id":"662b80db-cc71-40cf-b601-08d57983f6e4","name":"registry.humanitec.io/public/sample-app","type":"container","updated_at":"2020-06-12T10:00:00Z","updated_by":"987654321"},{"created_at":"2020-06-10T10:00:00Z","created_by":"1234567789","id":"abf214a0-5de0-430d-a0b4-bb9871567ade","name":"registry.humanitec.io/public/sample-service","type":"container","updated_at":"2020-06-12T10:00:00Z","updated_by":"987654321"}]
Up
delete /orgs/{orgId}/env-types/{envTypeId}
Deletes an Environment Type (orgsOrgIdEnvTypesEnvTypeIdDelete)
Deletes a specific Environment Type from an Organization. If there are Environments with this Type in the Organization, the operation will fail.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
envTypeId (required)
Path Parameter — ID of the Environment Type.
Return type
Example data
Content-Type: application/json
{
"description" : "Environments used for automated QA.",
"id" : "qa-automation"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
The Environment Type requested.
EnvironmentTypeResponse
401
The Authorization header was not present or invalid.
HumanitecErrorResponse
404
No Environment Type with ID <code>envTypeId</code> in Organization.
HumanitecErrorResponse
409
<p>There are 1 or more Environments with this Type.</p>
<p>To delete an Environment Type, there can be no Environments with that type in the Organization.</p>
Example data
Content-Type: application/json
[{"app_id":"my-app","env_id":"awesome-feature"},{"app_id":"my-app","env_id":"bugfix-7951"}]
Up
get /orgs/{orgId}/env-types/{envTypeId}
Get an Environment Type (orgsOrgIdEnvTypesEnvTypeIdGet)
Gets a specific Environment Type within an Organization.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
envTypeId (required)
Path Parameter — ID of the Environment Type.
Return type
Example data
Content-Type: application/json
{
"description" : "Environments used for automated QA.",
"id" : "qa-automation"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The Environment Type requested.
EnvironmentTypeResponse
404
No Environment Type with <code>id</code> in Organization.
HumanitecErrorResponse
Up
post /orgs/{orgId}/env-types/{envType}/users
Adds a User to an Environment Type with a Role (orgsOrgIdEnvTypesEnvTypeUsersPost)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
envType (required)
Path Parameter — The Environment Type.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The user ID and the role
example: {
"id" : "61048226-642c-438e-974f-ce5c013d94f8",
"role" : "manager"
}
Return type
Example data
Content-Type: application/json
{
"role" : "manager",
"user" : "61048226-642c-438e-974f-ce5c013d94f8",
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "730c1f96-8ee5-4bff-8c22-898e0530b924",
"invite" : "accepted",
"name" : "Jo Trigg",
"type" : "user"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The user ID and associated role.
UserRoleResponse
400
The request was invalid or the payload malformed.
HumanitecErrorResponse
404
The specified Application was not found.
Up
delete /orgs/{orgId}/env-types/{envType}/users/{userId}
Remove the role of a User on an Environment Type (orgsOrgIdEnvTypesEnvTypeUsersUserIdDelete)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
envType (required)
Path Parameter — The Environment Type.
userId (required)
Path Parameter — The User ID
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Role of the user successfully deleted.
400
The request was invalid or the payload malformed.
HumanitecErrorResponse
404
Object does not exist.
Up
get /orgs/{orgId}/env-types/{envType}/users/{userId}
Get the role of a User on an Environment Type (orgsOrgIdEnvTypesEnvTypeUsersUserIdGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
envType (required)
Path Parameter — The Environment Type.
userId (required)
Path Parameter — The User ID
Return type
Example data
Content-Type: application/json
{
"role" : "manager",
"user" : "61048226-642c-438e-974f-ce5c013d94f8",
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "730c1f96-8ee5-4bff-8c22-898e0530b924",
"invite" : "accepted",
"name" : "Jo Trigg",
"type" : "user"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The information on the user.
UserRoleResponse
400
The request was invalid or the payload malformed.
HumanitecErrorResponse
404
Object does not exist.
Up
patch /orgs/{orgId}/env-types/{envType}/users/{userId}
Update the role of a User on an Environment Type (orgsOrgIdEnvTypesEnvTypeUsersUserIdPatch)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
envType (required)
Path Parameter — The Environment Type.
userId (required)
Path Parameter — The User ID
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The new user role
Return type
Example data
Content-Type: application/json
{
"role" : "manager",
"user" : "61048226-642c-438e-974f-ce5c013d94f8",
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "730c1f96-8ee5-4bff-8c22-898e0530b924",
"invite" : "accepted",
"name" : "Jo Trigg",
"type" : "user"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The information on the user.
UserRoleResponse
400
The request was invalid or the payload malformed.
HumanitecErrorResponse
404
Object does not exist.
Up
get /orgs/{orgId}/env-types
List all Environment Types (orgsOrgIdEnvTypesGet)
Lists all Environment Types in an Organization.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Return type
Example data
Content-Type: application/json
[ {
"description" : "Environments used for automated QA.",
"id" : "qa-automation"
}, {
"description" : "Environments used for automated QA.",
"id" : "qa-automation"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A list of Environment Types.
Up
post /orgs/{orgId}/env-types
Add a new Environment Type (orgsOrgIdEnvTypesPost)
Adds a new Environment Type to an Organization.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — New Environment Type.
Return type
Example data
Content-Type: application/json
{
"description" : "Environments used for automated QA.",
"id" : "qa-automation"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
The Environment Type requested.
EnvironmentTypeResponse
400
The supplied <code>id</code> is not a valid ID or a required field is missing.
HumanitecErrorResponse
401
The Authorization header was not present or invalid.
HumanitecErrorResponse
409
The supplied <code>id</code> clashes with an existing Environment Type.
HumanitecErrorResponse
Up
get /orgs/{orgId}/events
List Events (orgsOrgIdEventsGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Return type
Example data
Content-Type: application/json
[ {
"scope" : "scope",
"type" : "type",
"properties" : [ "properties", "properties" ]
}, {
"scope" : "scope",
"type" : "type",
"properties" : [ "properties", "properties" ]
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A list of Events.
Get the specified Organization. (orgsOrgIdGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Return type
Example data
Content-Type: application/json
{
"name" : "name",
"created_at" : "2020-06-22T09:37:23.523Z",
"logo" : {
"light_url" : "light_url",
"dark_url" : "dark_url"
},
"id" : "id",
"created_by" : "created_by"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Returns organization details.
OrganizationResponse
400
Invalid request parameters or payload. E.g. invalid <code>orgId</code> format.
HumanitecErrorResponse
401
Required HTTP Authorization header is missing or malformed.
403
Current user is not authorized to perform the request.
409
Organization can't be accessed with this request.
HumanitecErrorResponse
Up
get /orgs/{orgId}/images
List all Container Images (orgsOrgIdImagesGet)
DEPRECATED: This endpoint exists for historical compatibility and should not be used. Please use the Artefact API instead.
Lists all of the Container Images registered for this organization.
Path parameters
orgId (required)
Path Parameter — The organization ID.
Return type
Example data
Content-Type: application/json
[ {
"added_at" : "22020-06-25T17:41:57Z",
"builds" : [ {
"added_at" : "2020-06-25T19:37:22Z",
"branch" : "master",
"commit" : "884bccaa807ea27cc1997a7492a3b6279fd7bd55",
"image" : "registry.humanitec.io/my-org/my-service:1.2.7"
}, {
"added_at" : "2020-06-25T17:41:57Z",
"branch" : "master",
"commit" : "060c3d6530a881afb808f105f36af25e1ad1b2f3",
"image" : "registry.humanitec.io/my-org/my-service:1.2.6"
} ],
"id" : "my-service",
"source" : "github"
}, {
"added_at" : "22020-06-25T17:41:57Z",
"builds" : [ {
"added_at" : "2020-06-25T19:37:22Z",
"branch" : "master",
"commit" : "884bccaa807ea27cc1997a7492a3b6279fd7bd55",
"image" : "registry.humanitec.io/my-org/my-service:1.2.7"
}, {
"added_at" : "2020-06-25T17:41:57Z",
"branch" : "master",
"commit" : "060c3d6530a881afb808f105f36af25e1ad1b2f3",
"image" : "registry.humanitec.io/my-org/my-service:1.2.6"
} ],
"id" : "my-service",
"source" : "github"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Possibly empty list of Container Images.
Example data
Content-Type: application/json
[{"added_at":"2020-05-12T16:12:13Z","builds":[{"added_at":"2020-06-25T19:37:22Z","branch":"master","commit":"884bccaa807ea27cc1997a7492a3b6279fd7bd55","image":"registry.humanitec.io/my-org/my-service:1.2.7"}],"id":"my-service","source":"github"}]
Up
get /orgs/{orgId}/images/{imageId}/builds
Lists all the Builds of an Image (orgsOrgIdImagesImageIdBuildsGet)
DEPRECATED: This endpoint exists for historical compatibility and should not be used. Please use the Artefact API instead.
The response lists all available Image Builds of an Image.
Path parameters
orgId (required)
Path Parameter — The organization ID.
imageId (required)
Path Parameter — The Image ID.
Return type
Example data
Content-Type: application/json
[ {
"added_at" : "2020-06-22T09:37:23.523Z",
"image" : "image",
"commit" : "commit",
"branch" : "branch",
"tags" : [ "tags", "tags" ]
}, {
"added_at" : "2020-06-22T09:37:23.523Z",
"image" : "image",
"commit" : "commit",
"branch" : "branch",
"tags" : [ "tags", "tags" ]
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Possibly empty list of Builds of Container Images.
Example data
Content-Type: application/json
[{"added_at":"2020-06-25T19:37:22Z","branch":"master","commit":"884bccaa807ea27cc1997a7492a3b6279fd7bd55","image":"registry.humanitec.io/my-org/my-service:1.2.7"},{"added_at":"2020-06-25T17:41:57Z","branch":"master","commit":"060c3d6530a881afb808f105f36af25e1ad1b2f3","image":"registry.humanitec.io/my-org/my-service:1.2.6"}]
404
No Image with an ID of <code>imageId</code> found within the organization.
HumanitecErrorResponse
Up
post /orgs/{orgId}/images/{imageId}/builds
Add a new Image Build (orgsOrgIdImagesImageIdBuildsPost)
DEPRECATED: This endpoint exists for historical compatibility and should not be used. Please use the Artefact API instead.
This endpoint is used by Continuous Integration (CI) pipelines to notify Humanitec that a new Image Build is available.
If there is no Image with ID imageId, it will be automatically created.
Path parameters
orgId (required)
Path Parameter — The organization ID.
imageId (required)
Path Parameter — The Image ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The metadata associated with the build.
example: {
"branch" : "master",
"commit" : "884bccaa807ea27cc1997a7492a3b6279fd7bd55",
"image" : "registry.humanitec.io/my-org/my-service:1.2.7"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Build successfully added.
400
The supplied <code>imageId</code> is invalid or a required field is missing.
HumanitecErrorResponse
401
Request unauthorised.
HumanitecErrorResponse
403
A build cannot be added to a builtin image.
HumanitecErrorResponse
Up
get /orgs/{orgId}/images/{imageId}
Get a specific Image Object (orgsOrgIdImagesImageIdGet)
DEPRECATED: This endpoint exists for historical compatibility and should not be used. Please use the Artefact API instead.
The response includes a list of Image Builds as well as some metadata about the Image such as its Image Source.
Note, imageId may not be the same as the container name. imageId is determined by the system making notifications about new builds.
Path parameters
orgId (required)
Path Parameter — The organization ID.
imageId (required)
Path Parameter — The Image ID.
Return type
Example data
Content-Type: application/json
{
"added_at" : "22020-06-25T17:41:57Z",
"builds" : [ {
"added_at" : "2020-06-25T19:37:22Z",
"branch" : "master",
"commit" : "884bccaa807ea27cc1997a7492a3b6279fd7bd55",
"image" : "registry.humanitec.io/my-org/my-service:1.2.7"
}, {
"added_at" : "2020-06-25T17:41:57Z",
"branch" : "master",
"commit" : "060c3d6530a881afb808f105f36af25e1ad1b2f3",
"image" : "registry.humanitec.io/my-org/my-service:1.2.6"
} ],
"id" : "my-service",
"source" : "github"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The Image Object requested.
ImageResponse
Example data
Content-Type: application/json
{"added_at":"22020-06-25T17:41:57Z","builds":[{"added_at":"2020-06-25T19:37:22Z","branch":"master","commit":"884bccaa807ea27cc1997a7492a3b6279fd7bd55","image":"registry.humanitec.io/my-org/my-service:1.2.7"},{"added_at":"2020-06-25T17:41:57Z","branch":"master","commit":"060c3d6530a881afb808f105f36af25e1ad1b2f3","image":"registry.humanitec.io/my-org/my-service:1.2.6"}],"id":"my-service","source":"github"}
404
No Image with an ID of <code>imageId</code> found within the organization.
HumanitecErrorResponse
Up
get /orgs/{orgId}/invitations
List the invites issued for the organization. (orgsOrgIdInvitationsGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Return type
Example data
Content-Type: application/json
[ {
"created_at" : "2020-12-19T09:32:46Z",
"created_by" : "admin-user-id",
"email" : "jo.trigg@awesomecorp.com",
"expires_at" : "2020-12-30T09:32:46Z",
"user_id" : "new-user-id"
}, {
"created_at" : "2020-12-19T09:32:46Z",
"created_by" : "admin-user-id",
"email" : "jo.trigg@awesomecorp.com",
"expires_at" : "2020-12-30T09:32:46Z",
"user_id" : "new-user-id"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The list of the invites issued for the organization.
Up
post /orgs/{orgId}/invitations
Invites a user to an Organization with a specified role. (orgsOrgIdInvitationsPost)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The email and the desired role
example: {
"email" : "jane.gonzales@example.com",
"role" : "manager"
}
Return type
Example data
Content-Type: application/json
[ {
"role" : "manager",
"user" : "61048226-642c-438e-974f-ce5c013d94f8",
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "730c1f96-8ee5-4bff-8c22-898e0530b924",
"invite" : "accepted",
"name" : "Jo Trigg",
"type" : "user"
}, {
"role" : "manager",
"user" : "61048226-642c-438e-974f-ce5c013d94f8",
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "730c1f96-8ee5-4bff-8c22-898e0530b924",
"invite" : "accepted",
"name" : "Jo Trigg",
"type" : "user"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
An temporary profile for the invited user.
400
The request was invalid or the payload malformed.
HumanitecErrorResponse
404
Object does not exist.
Up
get /orgs/{orgId}/registries
Lists available registries for the organization. (orgsOrgIdRegistriesGet)
Path parameters
orgId (required)
Path Parameter — Unique (alpha-numerical) organization identifier.
Return type
Example data
Content-Type: application/json
[ {
"created_at" : "2020-05-22T14:53:27Z",
"created_by" : "a.user@example.com",
"enable_ci" : false,
"id" : "humanitec",
"registry" : "registry.humanitec.io",
"secrets" : {
"*" : {
"namespace" : "dev-secrets",
"secret" : "custom-regcred"
},
"cluster-A" : {
"namespace" : "prod-secrets",
"secret" : "custom-regcred"
}
},
"type" : "basic"
}, {
"created_at" : "2020-05-22T14:53:27Z",
"created_by" : "a.user@example.com",
"enable_ci" : false,
"id" : "humanitec",
"registry" : "registry.humanitec.io",
"secrets" : {
"*" : {
"namespace" : "dev-secrets",
"secret" : "custom-regcred"
},
"cluster-A" : {
"namespace" : "prod-secrets",
"secret" : "custom-regcred"
}
},
"type" : "basic"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A Possibly empty list of Registries.
400
Request parameters are incomplete or invalid.
ErrorInfoResponse
404
Specified 'orgId' does not match any record.
ErrorInfoResponse
Up
post /orgs/{orgId}/registries
Creates a new registry record. (orgsOrgIdRegistriesPost)
Path parameters
orgId (required)
Path Parameter — Unique (alpha-numerical) organization identifier.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — A new record details.
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-05-22T14:53:27Z",
"created_by" : "a.user@example.com",
"enable_ci" : false,
"id" : "humanitec",
"registry" : "registry.humanitec.io",
"secrets" : {
"*" : {
"namespace" : "dev-secrets",
"secret" : "custom-regcred"
},
"cluster-A" : {
"namespace" : "prod-secrets",
"secret" : "custom-regcred"
}
},
"type" : "basic"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
A newly created record details.
RegistryResponse
400
Request parameters or payload are incomplete or invalid.
ErrorInfoResponse
401
Authentication token is missing or invalid.
ErrorInfoResponse
404
Specified 'orgId' does not match any record.
ErrorInfoResponse
409
The record with the same ID or name (prefix) already exists within the organization.
ErrorInfoResponse
Up
get /orgs/{orgId}/registries/{regId}/creds
Returns current account credentials or secret details for the registry. (orgsOrgIdRegistriesRegIdCredsGet)
Path parameters
orgId (required)
Path Parameter — Unique (alpha-numerical) organization identifier.
regId (required)
Path Parameter — Unique (alpha-numerical) registry identifier.
Return type
Example data
Content-Type: application/json
{
"expires" : "2020-05-22T14:53:27Z",
"password" : "",
"registry" : "registry.io/project",
"secrets" : {
"*" : {
"namespace" : "dev-secrets",
"secret" : "custom-regcred"
},
"cluster-A" : {
"namespace" : "prod-secrets",
"secret" : "custom-regcred"
}
},
"username" : ""
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Current account credentials or secret details for the registry.
RegistryCredsResponse
400
Request parameters are incomplete or invalid.
ErrorInfoResponse
401
Authentication token is missing or invalid.
ErrorInfoResponse
404
Specified 'orgId' or 'regId' do not match any record.
ErrorInfoResponse
Up
delete /orgs/{orgId}/registries/{regId}
Deletes an existing registry record and all associated credentials and secrets. (orgsOrgIdRegistriesRegIdDelete)
Deletions are currently irreversible.
Path parameters
orgId (required)
Path Parameter — Unique (alpha-numerical) organization identifier.
regId (required)
Path Parameter — Unique (alpha-numerical) registry identifier.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Deleted successfully.
400
Request parameters are incomplete or invalid.
ErrorInfoResponse
403
Built-in 'humanitec' registry can't be deleted.
ErrorInfoResponse
404
Specified 'orgId' or 'regId' do not match any record.
ErrorInfoResponse
Up
get /orgs/{orgId}/registries/{regId}
Loads a registry record details. (orgsOrgIdRegistriesRegIdGet)
Path parameters
orgId (required)
Path Parameter — Unique (alpha-numerical) organization identifier.
regId (required)
Path Parameter — Unique (alpha-numerical) registry identifier.
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-05-22T14:53:27Z",
"created_by" : "a.user@example.com",
"enable_ci" : false,
"id" : "humanitec",
"registry" : "registry.humanitec.io",
"secrets" : {
"*" : {
"namespace" : "dev-secrets",
"secret" : "custom-regcred"
},
"cluster-A" : {
"namespace" : "prod-secrets",
"secret" : "custom-regcred"
}
},
"type" : "basic"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
A registry details.
RegistryResponse
400
Request parameters are incomplete or invalid.
ErrorInfoResponse
404
Specified 'orgId' or 'regId' do not match any record.
ErrorInfoResponse
Up
patch /orgs/{orgId}/registries/{regId}
Updates (patches) an existing registry record. (orgsOrgIdRegistriesRegIdPatch)
Path parameters
orgId (required)
Path Parameter — Unique (alpha-numerical) organization identifier.
regId (required)
Path Parameter — Unique (alpha-numerical) registry identifier.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Record details to update.
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-05-22T14:53:27Z",
"created_by" : "a.user@example.com",
"enable_ci" : false,
"id" : "humanitec",
"registry" : "registry.humanitec.io",
"secrets" : {
"*" : {
"namespace" : "dev-secrets",
"secret" : "custom-regcred"
},
"cluster-A" : {
"namespace" : "prod-secrets",
"secret" : "custom-regcred"
}
},
"type" : "basic"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Updated record details.
RegistryResponse
400
Request parameters or payload are incomplete or invalid.
ErrorInfoResponse
403
Built-in 'humanitec' registry can't be changed.
ErrorInfoResponse
404
Specified 'orgId' or 'regId' do not match any record.
ErrorInfoResponse
409
The record with the same name (prefix) already exists within the organization.
ErrorInfoResponse
Up
get /orgs/{orgId}/resources/account-types
List Resource Account Types available to the organization. (orgsOrgIdResourcesAccountTypesGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Return type
Example data
Content-Type: application/json
[ {
"name" : "GCP",
"type" : "gcp"
}, {
"name" : "GCP",
"type" : "gcp"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty list of Resources Accounts Types.
500
Internal application error.
HumanitecErrorResponse
Up
delete /orgs/{orgId}/resources/accounts/{accId}
Delete an unused Resource Account. (orgsOrgIdResourcesAccountsAccIdDelete)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
accId (required)
Path Parameter — The Resource Account ID.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
The account was successfully deleted.
400
One or more request parameters is missing or invalid.
HumanitecErrorResponse
404
A Resource Account with the 'accId' ID is not found or does not belong to the organization.
HumanitecErrorResponse
500
Internal application error.
HumanitecErrorResponse
Up
get /orgs/{orgId}/resources/accounts/{accId}
Get a Resource Account. (orgsOrgIdResourcesAccountsAccIdGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
accId (required)
Path Parameter — The Resource Account ID.
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "test-user",
"id" : "gcp-dev-postgres",
"is_default" : false,
"is_used" : true,
"name" : "GCP Dev Postgres",
"type" : "gcp"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The requested Resources Account.
ResourceAccountResponse
404
A Resource Account with the 'accId' ID is not found or does not belong to the organization.
HumanitecErrorResponse
500
Internal application error.
HumanitecErrorResponse
Up
patch /orgs/{orgId}/resources/accounts/{accId}
Update a Resource Account. (orgsOrgIdResourcesAccountsAccIdPatch)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
accId (required)
Path Parameter — The Resource Account ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "test-user",
"id" : "gcp-dev-postgres",
"is_default" : false,
"is_used" : true,
"name" : "GCP Dev Postgres",
"type" : "gcp"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The updated Resource Account details.
ResourceAccountResponse
400
One or more request parameters is missing or invalid.
HumanitecErrorResponse
404
A Resource Account with the 'accId' ID is not found or does not belong to the organization.
HumanitecErrorResponse
500
Internal application error.
HumanitecErrorResponse
Up
get /orgs/{orgId}/resources/accounts
List Resource Accounts in the organization. (orgsOrgIdResourcesAccountsGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Return type
Example data
Content-Type: application/json
[ {
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "test-user",
"id" : "gcp-dev-postgres",
"is_default" : false,
"is_used" : true,
"name" : "GCP Dev Postgres",
"type" : "gcp"
}, {
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "test-user",
"id" : "gcp-dev-postgres",
"is_default" : false,
"is_used" : true,
"name" : "GCP Dev Postgres",
"type" : "gcp"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty list of Resources Accounts.
500
Internal application error.
HumanitecErrorResponse
Up
post /orgs/{orgId}/resources/accounts
Create a new Resource Account in the organization. (orgsOrgIdResourcesAccountsPost)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "test-user",
"id" : "gcp-dev-postgres",
"is_default" : false,
"is_used" : true,
"name" : "GCP Dev Postgres",
"type" : "gcp"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The newly created Resources Account details.
ResourceAccountResponse
400
One or more request parameters is missing or invalid.
HumanitecErrorResponse
401
Authentication token is missing or invalid.
HumanitecErrorResponse
409
A Resources Account already exists.
HumanitecErrorResponse
500
Internal application error.
HumanitecErrorResponse
Up
delete /orgs/{orgId}/resources/defs/{defId}/criteria/{criteriaId}
Delete a Matching Criteria from a Resource Definition. (orgsOrgIdResourcesDefsDefIdCriteriaCriteriaIdDelete)
If there are no Active Resources that would match to a different Resource Definition when the current Matching Criteria is deleted, the Matching Criteria is deleted immediately.
If there are Active Resources that would match to a different Resource Definition, the request fails with HTTP status code 409 (Conflict). The response content will list all of affected Active Resources and their new matches.
The request can take an optional force query parameter. If set to true, the Matching Criteria is deleted immediately. Referenced Active Resources would match to a different Resource Definition during the next deployment in the target environment.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
defId (required)
Path Parameter — The Resource Definition ID.
criteriaId (required)
Path Parameter — The Matching Criteria ID.
Query parameters
force (optional)
Query Parameter — If set to <code>true</code>, the Matching Criteria is deleted immediately, even if this action affects existing Active Resources.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Record deleted.
404
The Resource Definition is not found.
String
409
One or more Active Resources reference the Resource Definition through this Matching Criteria.
500
Internal application error.
HumanitecErrorResponse
Up
post /orgs/{orgId}/resources/defs/{defId}/criteria
Add a new Matching Criteria to a Resource Definition. (orgsOrgIdResourcesDefsDefIdCriteriaPost)
Matching Criteria are combined with Resource Type to select a specific definition. Matching Criteria can be set for any combination of Application ID, Environment ID, Environment Type, and Resource ID. In the event of multiple matches, the most specific match is chosen.
For example, given 3 sets of matching criteria for the same type:
1. {"env_type":"test"}
2. {"env_type":"development"}
3. {"env_type":"test", "app_id":"my-app"}
If, a resource of that time was needed in an Application my-app, Environment qa-team with Type test and Resource ID modules.my-module-externals.my-resource, there would be two resource definitions matching the criteria: #1 & #3. Definition #3 will be chosen because its matching criteria is the most specific.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
defId (required)
Path Parameter — The Resource Definition ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Matching Criteria rules.
example: {
"env_id" : "production"
}
Return type
Example data
Content-Type: application/json
{
"env_id" : "env_id",
"res_id" : "res_id",
"id" : "id",
"app_id" : "app_id",
"class" : "class",
"env_type" : "env_type"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The newly added Matching Criteria details.
MatchingCriteriaResponse
400
One or more request parameters is missing or invalid.
HumanitecErrorResponse
409
A Matching Criteria already exists.
HumanitecErrorResponse
500
Internal application error.
HumanitecErrorResponse
Up
delete /orgs/{orgId}/resources/defs/{defId}
Delete a Resource Definition. (orgsOrgIdResourcesDefsDefIdDelete)
If there are no Active Resources provisioned via the current definition, the Resource Definition is deleted immediately.
If there are Active Resources provisioned via the current definition, the request fails. The response will describe the changes to the affected Active Resources if operation is forced.
The request can take an optional force query parameter. If set to true, the current Resource Definition is marked as pending deletion and will be deleted (purged) as soon as no existing Active Resources reference it. With the next deployment matching criteria for Resources will be re-evaluated, and current Active Resources for the target environment would be either linked to another matching Resource Definition or decommissioned and created using the new or default Resource Definition (when available).
The Resource Definition that has been marked for deletion cannot be used to provision new resources.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
defId (required)
Path Parameter — The Resource Definition ID.
Query parameters
force (optional)
Query Parameter — If set to <code>true</code>, will mark the Resource Definition for deletion, even if it affects existing Active Resources.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Resource Definition has been marked for deletion.
404
A Resource Driver with the 'driverId' ID is not found or is not accessible by the organization.
HumanitecErrorResponse
409
List of Active Resources that still reference this Resource Definition.
500
Internal application error.
HumanitecErrorResponse
Up
get /orgs/{orgId}/resources/defs/{defId}
Get a specific Resource Definition. (orgsOrgIdResourcesDefsDefIdGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
defId (required)
Path Parameter — The Resource Definition ID.
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-05-23T12:32:16Z",
"created_by" : "a.user@example.com",
"criteria" : [ {
"env_type" : "development",
"id" : "123456"
} ],
"driver_account" : "gcp-dev-cloudsql",
"driver_inputs" : {
"secret_refs" : {
"credentials" : {
"password" : {
"value" : ""
},
"user" : {
"ref" : "vault/path/to/data/secrets/user",
"store" : "my-external-vault",
"version" : "1"
}
}
},
"values" : {
"instance" : "my-dev-project:my-region:dev-db"
}
},
"driver_type" : "humanitec/postgres-cloudsql",
"id" : "dev-postgres",
"is_default" : false,
"is_deleted" : false,
"name" : "Dev Postgres Instance",
"org_id" : "test-org",
"provision" : {
"aws-policy" : {
"is_dependent" : false,
"match_dependents" : false
},
"dns#my-dns" : { }
},
"type" : "postgres"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The requested Resources Definition details.
ResourceDefinitionResponse
404
A Resource Definition with the 'defId' ID is not found.
HumanitecErrorResponse
500
Internal application error.
HumanitecErrorResponse
Up
patch /orgs/{orgId}/resources/defs/{defId}
Update a Resource Definition. (orgsOrgIdResourcesDefsDefIdPatch)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
defId (required)
Path Parameter — The Resource Definition ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — <p>The Resource Definition record details.</p>
<p>The PATCH operation would change the value of the property if it is included in the request payload JSON, and not <code>null</code>. Missing and <code>null</code> properties are ignored.</p>
<p>For the map properties, such as PatchResourceDefinitionRequest.DriverInputs, the merge operation is applied.</p>
<p>Merge rules are as follows:</p>
<ul>
<li>
<p>If a map property has a value, it is replaced (or added).</p>
</li>
<li>
<p>If a map property is set to <code>null</code>, it is removed.</p>
</li>
<li>
<p>If a map property is not included (missing in JSON), it remains unchanged.</p>
</li>
</ul>
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-05-23T12:32:16Z",
"created_by" : "a.user@example.com",
"criteria" : [ {
"env_type" : "development",
"id" : "123456"
} ],
"driver_account" : "gcp-dev-cloudsql",
"driver_inputs" : {
"secret_refs" : {
"credentials" : {
"password" : {
"value" : ""
},
"user" : {
"ref" : "vault/path/to/data/secrets/user",
"store" : "my-external-vault",
"version" : "1"
}
}
},
"values" : {
"instance" : "my-dev-project:my-region:dev-db"
}
},
"driver_type" : "humanitec/postgres-cloudsql",
"id" : "dev-postgres",
"is_default" : false,
"is_deleted" : false,
"name" : "Dev Postgres Instance",
"org_id" : "test-org",
"provision" : {
"aws-policy" : {
"is_dependent" : false,
"match_dependents" : false
},
"dns#my-dns" : { }
},
"type" : "postgres"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The updated Resource Definition.
ResourceDefinitionResponse
400
One or more request parameters is missing or invalid.
HumanitecErrorResponse
404
A Resource Definition with the 'defId' ID is not found.
HumanitecErrorResponse
500
Internal application error.
HumanitecErrorResponse
Up
put /orgs/{orgId}/resources/defs/{defId}
Update a Resource Definition. (orgsOrgIdResourcesDefsDefIdPut)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
defId (required)
Path Parameter — The Resource Definition ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — <p>The Resource Definition record details.</p>
<p>The PUT operation updates a resource definition using the provided payload. An empty driver_account or driver_inputs property will unset the existing values.</p>
<p>Currently the resource and driver types can't be changed.</p>
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-05-23T12:32:16Z",
"created_by" : "a.user@example.com",
"criteria" : [ {
"env_type" : "development",
"id" : "123456"
} ],
"driver_account" : "gcp-dev-cloudsql",
"driver_inputs" : {
"secret_refs" : {
"credentials" : {
"password" : {
"value" : ""
},
"user" : {
"ref" : "vault/path/to/data/secrets/user",
"store" : "my-external-vault",
"version" : "1"
}
}
},
"values" : {
"instance" : "my-dev-project:my-region:dev-db"
}
},
"driver_type" : "humanitec/postgres-cloudsql",
"id" : "dev-postgres",
"is_default" : false,
"is_deleted" : false,
"name" : "Dev Postgres Instance",
"org_id" : "test-org",
"provision" : {
"aws-policy" : {
"is_dependent" : false,
"match_dependents" : false
},
"dns#my-dns" : { }
},
"type" : "postgres"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The updated Resource Definition.
ResourceDefinitionResponse
400
One or more request parameters is missing or invalid.
HumanitecErrorResponse
404
A Resource Definition with the 'defId' ID is not found.
HumanitecErrorResponse
500
Internal application error.
HumanitecErrorResponse
Up
get /orgs/{orgId}/resources/defs/{defId}/resources
List Active Resources provisioned via a specific Resource Definition. (orgsOrgIdResourcesDefsDefIdResourcesGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
defId (required)
Path Parameter — The Resource Definition ID.
Return type
Example data
Content-Type: application/json
[ {
"app_id" : "test-app",
"class" : "default",
"def_id" : "gcp-dev-postgres",
"deploy_id" : "172a1013b",
"env_id" : "gcp-dev",
"env_type" : "development",
"gu_res_id" : "7bd3966c9ff8eaa66c5cce855c03d715857c3440",
"org_id" : "test-org",
"res_id" : "modules.my-module.externals.my-db",
"resource" : {
"values" : {
"host" : "127.0.0.1",
"name" : "db_33c7ef9b_8d90-4c62_a1cf_0cdd30fd29a9",
"port" : 5432
}
},
"type" : "postgres",
"updated_at" : "2020-06-23T16:53:12Z"
}, {
"app_id" : "test-app",
"class" : "default",
"def_id" : "gcp-dev-postgres",
"deploy_id" : "172a1013b",
"env_id" : "gcp-dev",
"env_type" : "development",
"gu_res_id" : "7bd3966c9ff8eaa66c5cce855c03d715857c3440",
"org_id" : "test-org",
"res_id" : "modules.my-module.externals.my-db",
"resource" : {
"values" : {
"host" : "127.0.0.1",
"name" : "db_33c7ef9b_8d90-4c62_a1cf_0cdd30fd29a9",
"port" : 5432
}
},
"type" : "postgres",
"updated_at" : "2020-06-23T16:53:12Z"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty list of Active Resources.
500
Internal application error.
HumanitecErrorResponse
Up
get /orgs/{orgId}/resources/defs
List Resource Definitions. (orgsOrgIdResourcesDefsGet)
Filter criteria can be applied to obtain all the resource definitions that could match the filters, grouped by type and sorted by matching rank.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Query parameters
app (optional)
Query Parameter — (Optional) Filter Resource Definitions that may match a specific Application.
env (optional)
Query Parameter — (Optional) Filter Resource Definitions that may match a specific Environment.
env_type (optional)
Query Parameter — (Optional) Filter Resource Definitions that may match a specific Environment Type.
res (optional)
Query Parameter — (Optional) Filter Resource Definitions that may match a specific Resource.
res_type (optional)
Query Parameter — (Optional) Filter Resource Definitions that may match a specific Resource Type.
class (optional)
Query Parameter — (Optional) Filter Resource Definitions that may match a specific Class.
Return type
Example data
Content-Type: application/json
[ {
"created_at" : "2020-05-23T12:32:16Z",
"created_by" : "a.user@example.com",
"criteria" : [ {
"env_type" : "development",
"id" : "123456"
} ],
"driver_account" : "gcp-dev-cloudsql",
"driver_inputs" : {
"secret_refs" : {
"credentials" : {
"password" : {
"value" : ""
},
"user" : {
"ref" : "vault/path/to/data/secrets/user",
"store" : "my-external-vault",
"version" : "1"
}
}
},
"values" : {
"instance" : "my-dev-project:my-region:dev-db"
}
},
"driver_type" : "humanitec/postgres-cloudsql",
"id" : "dev-postgres",
"is_default" : false,
"is_deleted" : false,
"name" : "Dev Postgres Instance",
"org_id" : "test-org",
"provision" : {
"aws-policy" : {
"is_dependent" : false,
"match_dependents" : false
},
"dns#my-dns" : { }
},
"type" : "postgres"
}, {
"created_at" : "2020-05-23T12:32:16Z",
"created_by" : "a.user@example.com",
"criteria" : [ {
"env_type" : "development",
"id" : "123456"
} ],
"driver_account" : "gcp-dev-cloudsql",
"driver_inputs" : {
"secret_refs" : {
"credentials" : {
"password" : {
"value" : ""
},
"user" : {
"ref" : "vault/path/to/data/secrets/user",
"store" : "my-external-vault",
"version" : "1"
}
}
},
"values" : {
"instance" : "my-dev-project:my-region:dev-db"
}
},
"driver_type" : "humanitec/postgres-cloudsql",
"id" : "dev-postgres",
"is_default" : false,
"is_deleted" : false,
"name" : "Dev Postgres Instance",
"org_id" : "test-org",
"provision" : {
"aws-policy" : {
"is_dependent" : false,
"match_dependents" : false
},
"dns#my-dns" : { }
},
"type" : "postgres"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty list of Resources Definitions.
500
Internal application error.
HumanitecErrorResponse
Up
post /orgs/{orgId}/resources/defs
Create a new Resource Definition. (orgsOrgIdResourcesDefsPost)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The Resource Definition details.
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-05-23T12:32:16Z",
"created_by" : "a.user@example.com",
"criteria" : [ {
"env_type" : "development",
"id" : "123456"
} ],
"driver_account" : "gcp-dev-cloudsql",
"driver_inputs" : {
"secret_refs" : {
"credentials" : {
"password" : {
"value" : ""
},
"user" : {
"ref" : "vault/path/to/data/secrets/user",
"store" : "my-external-vault",
"version" : "1"
}
}
},
"values" : {
"instance" : "my-dev-project:my-region:dev-db"
}
},
"driver_type" : "humanitec/postgres-cloudsql",
"id" : "dev-postgres",
"is_default" : false,
"is_deleted" : false,
"name" : "Dev Postgres Instance",
"org_id" : "test-org",
"provision" : {
"aws-policy" : {
"is_dependent" : false,
"match_dependents" : false
},
"dns#my-dns" : { }
},
"type" : "postgres"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The newly created Resources Definition details.
ResourceDefinitionResponse
400
One or more request parameters is missing or invalid.
HumanitecErrorResponse
409
A Resources Definition already exists.
HumanitecErrorResponse
500
Internal application error.
HumanitecErrorResponse
Up
delete /orgs/{orgId}/resources/drivers/{driverId}
Delete a Resources Driver. (orgsOrgIdResourcesDriversDriverIdDelete)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
driverId (required)
Path Parameter — The Resources Driver ID to delete.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Record deleted.
500
Internal application error.
HumanitecErrorResponse
Up
get /orgs/{orgId}/resources/drivers/{driverId}
Get a Resource Driver. (orgsOrgIdResourcesDriversDriverIdGet)
Only drivers that belongs to the given organization or registered as public are accessible through this endpoint
Path parameters
orgId (required)
Path Parameter — The Organization ID.
driverId (required)
Path Parameter — The Resource Driver ID.
Return type
Example data
Content-Type: application/json
{
"account_types" : [ "gcp", "aws" ],
"id" : "route53",
"inputs_schema" : { },
"is_public" : false,
"org_id" : "test-org",
"target" : "https://drivers.example.com/route53/",
"template" : "",
"type" : "dns"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The requested Resources Driver details.
DriverDefinitionResponse
404
A Resource Driver with the 'driverId' ID is not found or is not accessible by the organization.
HumanitecErrorResponse
500
Internal application error.
HumanitecErrorResponse
Up
put /orgs/{orgId}/resources/drivers/{driverId}
Update a Resource Driver. (orgsOrgIdResourcesDriversDriverIdPut)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
driverId (required)
Path Parameter — The Resource Driver ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"account_types" : [ "gcp", "aws" ],
"id" : "route53",
"inputs_schema" : { },
"is_public" : false,
"org_id" : "test-org",
"target" : "https://drivers.example.com/route53/",
"template" : "",
"type" : "dns"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The updated Resources Driver details.
DriverDefinitionResponse
400
One or more request parameters is missing or invalid.
HumanitecErrorResponse
404
A Resources Driver with the 'driverId' ID is not found.
HumanitecErrorResponse
500
Internal application error.
HumanitecErrorResponse
Up
get /orgs/{orgId}/resources/drivers
List Resource Drivers. (orgsOrgIdResourcesDriversGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Return type
Example data
Content-Type: application/json
[ {
"account_types" : [ "gcp", "aws" ],
"id" : "route53",
"inputs_schema" : { },
"is_public" : false,
"org_id" : "test-org",
"target" : "https://drivers.example.com/route53/",
"template" : "",
"type" : "dns"
}, {
"account_types" : [ "gcp", "aws" ],
"id" : "route53",
"inputs_schema" : { },
"is_public" : false,
"org_id" : "test-org",
"target" : "https://drivers.example.com/route53/",
"template" : "",
"type" : "dns"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty list of Resources Drivers.
500
Internal application error.
HumanitecErrorResponse
Up
post /orgs/{orgId}/resources/drivers
Register a new Resource Driver. (orgsOrgIdResourcesDriversPost)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Resources Driver details.
Return type
Example data
Content-Type: application/json
{
"account_types" : [ "gcp", "aws" ],
"id" : "route53",
"inputs_schema" : { },
"is_public" : false,
"org_id" : "test-org",
"target" : "https://drivers.example.com/route53/",
"template" : "",
"type" : "dns"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The newly registered Resources Driver details.
DriverDefinitionResponse
400
One or more request parameters is missing or invalid.
HumanitecErrorResponse
409
A Resources Driver already exists.
HumanitecErrorResponse
500
Internal application error.
HumanitecErrorResponse
Up
get /orgs/{orgId}/resources/types
List Resource Types. (orgsOrgIdResourcesTypesGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Return type
Example data
Content-Type: application/json
[ {
"inputs_schema" : {
"values" : {
"properties" : {
"extensions" : {
"additionalProperties" : {
"properties" : {
"schema" : {
"type" : "string"
},
"version" : {
"type" : "string"
}
},
"type" : "object"
}
}
},
"type" : "object"
}
},
"name" : "PostgreSQL",
"outputs_schema" : {
"secrets" : {
"properties" : {
"password" : {
"type" : "string"
},
"username" : {
"type" : "string"
}
},
"required" : [ "username", "password" ],
"type" : "object"
},
"values" : {
"properties" : {
"host" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"port" : {
"maximum" : 65535,
"minimum" : 0,
"type" : "integer"
}
},
"required" : [ "name", "host", "port" ],
"type" : "object"
}
},
"type" : "postgres",
"use" : "direct"
}, {
"inputs_schema" : {
"values" : {
"properties" : {
"extensions" : {
"additionalProperties" : {
"properties" : {
"schema" : {
"type" : "string"
},
"version" : {
"type" : "string"
}
},
"type" : "object"
}
}
},
"type" : "object"
}
},
"name" : "PostgreSQL",
"outputs_schema" : {
"secrets" : {
"properties" : {
"password" : {
"type" : "string"
},
"username" : {
"type" : "string"
}
},
"required" : [ "username", "password" ],
"type" : "object"
},
"values" : {
"properties" : {
"host" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"port" : {
"maximum" : 65535,
"minimum" : 0,
"type" : "integer"
}
},
"required" : [ "name", "host", "port" ],
"type" : "object"
}
},
"type" : "postgres",
"use" : "direct"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty list of Resources Types.
500
Internal application error.
HumanitecErrorResponse
Up
get /orgs/{orgId}/secretstores
Get list of Secret Stores for the given organization. (orgsOrgIdSecretstoresGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Return type
Example data
Content-Type: application/json
[ {
"gcpsm" : {
"project_id" : "project_id"
},
"updated_at" : "2020-06-22T09:37:23.523Z",
"humanitec" : { },
"updated_by" : "updated_by",
"awssm" : {
"endpoint" : "endpoint",
"region" : "region"
},
"created_at" : "2020-06-22T09:37:23.523Z",
"azurekv" : {
"tenant_id" : "tenant_id",
"url" : "url"
},
"id" : "id",
"created_by" : "created_by",
"vault" : {
"path" : "path",
"agent_id" : "agent_id",
"url" : "url"
},
"primary" : true
}, {
"gcpsm" : {
"project_id" : "project_id"
},
"updated_at" : "2020-06-22T09:37:23.523Z",
"humanitec" : { },
"updated_by" : "updated_by",
"awssm" : {
"endpoint" : "endpoint",
"region" : "region"
},
"created_at" : "2020-06-22T09:37:23.523Z",
"azurekv" : {
"tenant_id" : "tenant_id",
"url" : "url"
},
"id" : "id",
"created_by" : "created_by",
"vault" : {
"path" : "path",
"agent_id" : "agent_id",
"url" : "url"
},
"primary" : true
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
List of Secret Stores.
Up
post /orgs/{orgId}/secretstores
Create a Secret Store for the given organization. (orgsOrgIdSecretstoresPost)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Secret Store data.
Return type
Example data
Content-Type: application/json
{
"gcpsm" : {
"project_id" : "project_id"
},
"updated_at" : "2020-06-22T09:37:23.523Z",
"humanitec" : { },
"updated_by" : "updated_by",
"awssm" : {
"endpoint" : "endpoint",
"region" : "region"
},
"created_at" : "2020-06-22T09:37:23.523Z",
"azurekv" : {
"tenant_id" : "tenant_id",
"url" : "url"
},
"id" : "id",
"created_by" : "created_by",
"vault" : {
"path" : "path",
"agent_id" : "agent_id",
"url" : "url"
},
"primary" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Secret Store successfully added.
SecretStoreResponse
400
One or more request body parameters are either missing, invalid, or the requested payload is not provided or is malformed.
HumanitecErrorResponse
401
Request unauthorised.
HumanitecErrorResponse
409
Conflict.
HumanitecErrorResponse
Up
delete /orgs/{orgId}/secretstores/{storeId}
Delete the Secret Store. (orgsOrgIdSecretstoresStoreIdDelete)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
storeId (required)
Path Parameter — The Secret Store ID.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Secret Store successfully deleted.
404
Secret Store not found.
HumanitecErrorResponse
Up
get /orgs/{orgId}/secretstores/{storeId}
Get the Secret Store. (orgsOrgIdSecretstoresStoreIdGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
storeId (required)
Path Parameter — The Secret Store ID.
Return type
Example data
Content-Type: application/json
{
"gcpsm" : {
"project_id" : "project_id"
},
"updated_at" : "2020-06-22T09:37:23.523Z",
"humanitec" : { },
"updated_by" : "updated_by",
"awssm" : {
"endpoint" : "endpoint",
"region" : "region"
},
"created_at" : "2020-06-22T09:37:23.523Z",
"azurekv" : {
"tenant_id" : "tenant_id",
"url" : "url"
},
"id" : "id",
"created_by" : "created_by",
"vault" : {
"path" : "path",
"agent_id" : "agent_id",
"url" : "url"
},
"primary" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Returns Secret Stores.
SecretStoreResponse
404
Secret Store not found.
HumanitecErrorResponse
Up
patch /orgs/{orgId}/secretstores/{storeId}
Update the Secret Store. (orgsOrgIdSecretstoresStoreIdPatch)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
storeId (required)
Path Parameter — The Secret Store ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Secret Store data.
Return type
Example data
Content-Type: application/json
{
"gcpsm" : {
"project_id" : "project_id"
},
"updated_at" : "2020-06-22T09:37:23.523Z",
"humanitec" : { },
"updated_by" : "updated_by",
"awssm" : {
"endpoint" : "endpoint",
"region" : "region"
},
"created_at" : "2020-06-22T09:37:23.523Z",
"azurekv" : {
"tenant_id" : "tenant_id",
"url" : "url"
},
"id" : "id",
"created_by" : "created_by",
"vault" : {
"path" : "path",
"agent_id" : "agent_id",
"url" : "url"
},
"primary" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Secret Store successfully updated.
SecretStoreResponse
400
One or more request body parameters are either missing, invalid, or the requested payload is not provided or is malformed.
HumanitecErrorResponse
404
Secret Store not found.
HumanitecErrorResponse
Up
get /orgs/{orgId}/users
List Users with roles in an Organization (orgsOrgIdUsersGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Return type
Example data
Content-Type: application/json
[ {
"role" : "manager",
"user" : "61048226-642c-438e-974f-ce5c013d94f8",
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "730c1f96-8ee5-4bff-8c22-898e0530b924",
"invite" : "accepted",
"name" : "Jo Trigg",
"type" : "user"
}, {
"role" : "manager",
"user" : "61048226-642c-438e-974f-ce5c013d94f8",
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "730c1f96-8ee5-4bff-8c22-898e0530b924",
"invite" : "accepted",
"name" : "Jo Trigg",
"type" : "user"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A list of Users and the roles they hold.
404
Object does not exist.
Up
post /orgs/{orgId}/users
Creates a new service user. (orgsOrgIdUsersPost)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The user ID and the role
example: {
"id" : "61048226-642c-438e-974f-ce5c013d94f8",
"role" : "manager",
"name" : "CI Robot"
}
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "d510224a-4641-48fd-8054-68efd3537ee2",
"name" : "Jo Trigg",
"type" : "user"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The extended user profile of the user.
UserProfileResponse
400
The request was invalid or the payload malformed.
HumanitecErrorResponse
422
The request body was not parseable.
403
Token is not valid for a user.
Up
delete /orgs/{orgId}/users/{userId}
Remove the role of a User on an Organization (orgsOrgIdUsersUserIdDelete)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
userId (required)
Path Parameter — The User ID
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Role of the user successfully deleted.
400
The request was invalid or the payload malformed.
HumanitecErrorResponse
404
Object does not exist.
Up
get /orgs/{orgId}/users/{userId}
Get the role of a User on an Organization (orgsOrgIdUsersUserIdGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
userId (required)
Path Parameter — The User ID
Return type
Example data
Content-Type: application/json
{
"role" : "manager",
"user" : "61048226-642c-438e-974f-ce5c013d94f8",
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "730c1f96-8ee5-4bff-8c22-898e0530b924",
"invite" : "accepted",
"name" : "Jo Trigg",
"type" : "user"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The information on the user.
UserRoleResponse
400
The request was invalid or the payload malformed.
HumanitecErrorResponse
404
Object does not exist.
Up
patch /orgs/{orgId}/users/{userId}
Update the role of a User on an Organization (orgsOrgIdUsersUserIdPatch)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
userId (required)
Path Parameter — The User ID
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The new user the role
Return type
Example data
Content-Type: application/json
{
"role" : "manager",
"user" : "61048226-642c-438e-974f-ce5c013d94f8",
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "730c1f96-8ee5-4bff-8c22-898e0530b924",
"invite" : "accepted",
"name" : "Jo Trigg",
"type" : "user"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The information on the user.
UserRoleResponse
400
The request was invalid or the payload malformed.
HumanitecErrorResponse
404
Object does not exist.
Up
get /orgs/{orgId}/workload-profiles
List workload profiles available to the organization. (orgsOrgIdWorkloadProfilesGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID
Query parameters
per_page (optional)
Query Parameter — The maximum number of items to return in a page of results default: 50
page (optional)
Query Parameter — The page token to request from
Return type
Example data
Content-Type: application/json
[ {
"org_id" : "org_id",
"created_at" : "2020-06-22T09:37:23.523Z",
"id" : "id",
"created_by" : "created_by",
"latest" : "latest"
}, {
"org_id" : "org_id",
"created_at" : "2020-06-22T09:37:23.523Z",
"id" : "id",
"created_by" : "created_by",
"latest" : "latest"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
List of Workload Profiles.
Up
post /orgs/{orgId}/workload-profiles
Create new Workload Profile (orgsOrgIdWorkloadProfilesPost)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Workload profile details.
Return type
Example data
Content-Type: application/json
{
"org_id" : "org_id",
"created_at" : "2020-06-22T09:37:23.523Z",
"id" : "id",
"created_by" : "created_by",
"latest" : "latest"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
The newly created Workload Profile.
WorkloadProfileResponse
400
One or more request parameters is missing or invalid.
HumanitecErrorResponse
409
A Workload Profile already exists.
HumanitecErrorResponse
Up
delete /orgs/{orgId}/workload-profiles/{profileId}/versions/{version}
Delete a Workload Profile Version (orgsOrgIdWorkloadProfilesProfileIdVersionsVersionDelete)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
profileId (required)
Path Parameter — The Workload profile ID.
version (required)
Path Parameter — The Version.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
The Workload Profile Version has been marked for deletion.
404
The Workload Profile Version is not found or is not accessible by the organization.
HumanitecErrorResponse
Up
delete /orgs/{orgId}/workload-profiles/{profileQid}
Delete a Workload Profile (orgsOrgIdWorkloadProfilesProfileQidDelete)
This will also delete all versions of a workload profile.
It is not possible to delete profiles of other organizations.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
profileQid (required)
Path Parameter — The Workload profile ID.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
The Workload Profile has been marked for deletion.
404
The Workload Profile is not found or is not accessible by the organization.
HumanitecErrorResponse
Up
get /orgs/{orgId}/workload-profiles/{profileQid}
Get a Workload Profile (orgsOrgIdWorkloadProfilesProfileQidGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
profileQid (required)
Path Parameter — The fully qualified Workload ID. (If not a profile from the current org, must be prefixed with <code>{orgId}.</code> e.g. <code>humanitec.default-cronjob</code>)
Return type
Example data
Content-Type: application/json
{
"org_id" : "org_id",
"created_at" : "2020-06-22T09:37:23.523Z",
"id" : "id",
"created_by" : "created_by",
"latest" : "latest"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The requested WorkloadProfile.
WorkloadProfileResponse
404
The requested WorkloadProfile is not found.
HumanitecErrorResponse
Up
put /orgs/{orgId}/apps/{appId}/deltas/{deltaId}
Update an existing Delta (putDelta)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
deltaId (required)
Path Parameter — ID of the Delta to update.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — <p>An array of Deltas.</p>
<p>The Deltas in the request are combined, meaning the current Delta is updated in turn by each Delta in the request. Once all Deltas have been combined, the resulting Delta is simplified.</p>
<ul>
<li>
<p>All Modules in the <code>modules.add</code> property are replaced with the new Delta's values. If the value of a Module is <code>null</code>, and the ID is in the <code>modules.remove</code> list, it is removed from the <code>modules.remove</code> list.</p>
</li>
<li>
<p>All IDs listed in <code>modules.remove</code> are combined. Any ID in <code>modules.remove</code> and also in <code>modules.add</code> are removed from <code>modules.add</code></p>
</li>
<li>
<p>The lists of JSON Patches in <code>modules.update</code> are concatenated or created in <code>modules.updates</code>.</p>
</li>
</ul>
<p>Simplification involves:</p>
<ul>
<li>
<p>Applying any entries in <code>modules.updates</code> that have matching IDs in <code>modules.add</code> to the <code>modules.add</code> entry and removing the <code>modules.update</code> entry.</p>
</li>
<li>
<p>Reducing the number of JSON Patches in each <code>modules.update</code> entry to the smallest set that has the same effect.</p>
</li>
</ul>
<p><strong>Extension to JSON Patch</strong></p>
<p>If a JSON Patch entry needs to be removed, without side effects, the <code>value</code> of the <code>remove</code> action can be set to `{"scope": "delta"}. This will result in the remove action being used during simplification but be discarded before the Delta is finalized.</p>
<p>If the user making the request is not the user who created the Delta and they are not already on the contributors list, they will be added to the contributors list.</p>
<p><em>NOTE: If the <code>id</code> or <code>metadata</code> properties are specified, they will be ignored.</em></p>
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
The requested Deployment Delta.
400
The request was invalid.
HumanitecErrorResponse
404
No Deployment Delta with ID <code>deltaId</code> found in Application.
String
Up
post /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}/runs/{runId}/restart
Restart a Run within an Pipeline by cloning it with the same trigger and inputs. (restartRun)
Attempts to copy and restart the specified Run. The run must be in a completed state.
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
runId (required)
Path Parameter — The Run ID
Request headers
Return type
Example data
Content-Type: application/json
{
"pipeline_version" : "01234567-89ab-cdef-0123-456789abcdef",
"status_message" : "Example text",
"executing_at" : "2023-01-01T00:00:00Z",
"concurrency_group" : "my-group",
"inputs" : {
"fizz" : "buzz"
},
"created_at" : "2023-01-01T00:00:00Z",
"cancellation_requested_at" : "2023-01-01T00:00:00Z",
"run_as" : "s-01234567-89ab-cdef-0123-456789abcdef",
"waiting_for" : {
"key" : "waiting_for"
},
"completed_at" : "2023-01-01T00:00:00Z",
"org_id" : "sample-org",
"pipeline_id" : "sample-pipeline",
"etag" : "1234567890abcdef",
"id" : "01234567-89ab-cdef-0123-456789abcdef",
"timeout_seconds" : 3600,
"app_id" : "sample-app",
"status" : "executing"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Successful restart response.
RunResponse
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
409
The request itself is valid however it could not be applied based on the current state of the resource.
More detail can be found in the error body.
HumanitecErrorResponse
422
Server understands the content type of the request, and the syntax of the request is correct, but it was unable to process the contained instructions
ErrorResponse
DEPRECATED (tokensGet)
Return type
map[String, Object]
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The token structure.
Up
delete /tokens/{tokenId}
DEPRECATED (tokensTokenIdDelete)
Path parameters
tokenId (required)
Path Parameter — The token ID
Responses
204
Deleted
Up
patch /orgs/{orgId}/apps/{appId}/pipelines/{pipelineId}
update a Pipeline within an Application. (updatePipeline)
Path parameters
orgId (required)
Path Parameter — The Organization ID
appId (required)
Path Parameter — The Application ID
pipelineId (required)
Path Parameter — The Pipeline ID
Consumes
This API call consumes the following media types via the request header:
Request body
Request headers
Return type
Example data
Content-Type: application/json
{
"metadata" : {
"key" : "metadata"
},
"trigger_types" : [ "pipeline_call" ],
"org_id" : "sample-org",
"name" : "Sample Pipeline",
"created_at" : "2023-01-01T00:00:00Z",
"etag" : "1234567890abcdef",
"id" : "sample-pipeline",
"app_id" : "sample-app",
"version" : "01234567-89ab-cdef-0123-456789abcdef",
"status" : "active"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Successful get response.
Pipeline
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
409
The request itself is valid however it could not be applied based on the current state of the resource.
More detail can be found in the error body.
HumanitecErrorResponse
412
The request itself is valid however it could not be applied because the Etag does not match.
ErrorResponse
DEPRECATED (usersMeGet)
Return type
map[String, Object]
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The extended user profile of the user.
401
No token supplied.
403
Token is not valid for a user.
Up
get /users/{userId}/tokens
Lists tokens associated with a user (usersUserIdTokensGet)
Path parameters
userId (required)
Path Parameter — The user ID.
Return type
Example data
Content-Type: application/json
[ {
"created_at" : "2021-04-30T19:47:01Z",
"description" : "Humanitec API Calls from CircleCI Pipelines",
"expires_at" : "2022-04-30T19:47:01Z",
"id" : "circle-ci-token",
"type" : "static",
"user_id" : "a7a04740ae985f12af58545e4edbac6a"
}, {
"created_at" : "2021-04-30T19:47:01Z",
"description" : "Humanitec API Calls from CircleCI Pipelines",
"expires_at" : "2022-04-30T19:47:01Z",
"id" : "circle-ci-token",
"type" : "static",
"user_id" : "a7a04740ae985f12af58545e4edbac6a"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty list of tokens.
403
Calling user does not have permission to list tokens for this user.
Up
post /users/{userId}/tokens
Creates a new static token for a user. (usersUserIdTokensPost)
This is only supported for users of type service.
Path parameters
userId (required)
Path Parameter — The user ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The definition of the token.
Return type
Example data
Content-Type: application/json
{
"token" : "a7a04740ae985f12af58545e4edbac6a",
"type" : "jwt"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The issued static token.
TokenResponse
400
The request was invalid or the payload malformed.
HumanitecErrorResponse
403
Calling user does not have permission to list tokens for this user.
409
There is already a token with the given ID.
Up
delete /users/{userId}/tokens/{tokenId}
Deletes a specific token associated with a user (usersUserIdTokensTokenIdDelete)
This is only possible for static tokens. To revoke session tokens - use POST /auth/logout with the required session token.
Path parameters
userId (required)
Path Parameter — The user ID.
tokenId (required)
Path Parameter — The token ID.
Responses
204
The token was successfully deleted.
400
The request is invalid.
403
The calling user does not have permission to delete the token.
404
This token id is not available for the user or the user does not exist.
Up
get /users/{userId}/tokens/{tokenId}
Gets a specific token associated with a user (usersUserIdTokensTokenIdGet)
Path parameters
userId (required)
Path Parameter — The user ID.
tokenId (required)
Path Parameter — The token ID.
Return type
Example data
Content-Type: application/json
{
"created_at" : "2021-04-30T19:47:01Z",
"description" : "Humanitec API Calls from CircleCI Pipelines",
"expires_at" : "2022-04-30T19:47:01Z",
"id" : "circle-ci-token",
"type" : "static",
"user_id" : "a7a04740ae985f12af58545e4edbac6a"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Metadata about the token.
TokenInfoResponse
403
Calling user does not have permission to list tokens for this user.
404
This token ID is not available for the user.
Up
post /orgs/{orgId}/keys
Associate a new RSA public key to an organization. (createPublicKey)
Path parameters
orgId (required)
Path Parameter — The organization ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — A pcks8 RSA public key PEM encoded (as the ones produced by openssl), whose module length is greater or equal than 4096 bits. It should be provided as a single line. This might be accomplished through the usage of <code>awk</code> bash tool: <code>awk -v ORS='\n' '1' public_key.pem</code>
example: "-----BEGIN PUBLIC KEY-----\\nMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAo22jj/h+WPhL5M8RUyqC\\nEqRK3FOYD6KuDTyUHZL2QUX/q35bT1aGIOtu+22oM/8hTZ/6+BTknvF+Z+e7At8E\\n/I6/qNZilJFH/HqNHYflykceILVCFQM6v0ar6CSPh88DjwQPGLrh+UYp0NKBF6D5\\n2LEVQpxsM/0qV4fOZngRVI9UeKiYehk8aXJi20nI5Cj9GnV7BuEo7sKq7NewTOMN\\nwHqSnCtMV+E7SIgyy4+aKAFHOR0Y4FgJN14bAjE2GX/VUmAYBNtPgGwkCNDbA9v1\\nJJnFmdKflp8foqeWwC9UcUDLqjZzMT2a16pnL89iHV4fJ4vI6h26Jf2wUJbb7xE3\\nxJNhCR9Qf2IHx8TTVetIRl5I/ZUPkRrq5iskOIWV4+I+NzS+gbnCUv6sCO3cnZaa\\noZ4Wk5V+5qfctANeTn0TEAabYAJ/zFgYcs2IwYNqcN5eTss99zGNgtDL3oJr/A6g\\neGBgzad3p80qPMb1le64cHAAFZaerI2kcdnNpWGLXJ/J7IKF9uNfsrvi7Zdv8AXg\\nVAyqBARfzSkgnUKN6iWkWxAAzylKnQ3Etw81huaLwDG/6Lqd8I5OePMwHEZkollD\\nEBD16L/iyV9veru2zLVXkX/nL64YtZERLOWI5NUMaSurAR4N3ptFAsDRcO5Z4+Dq\\nO3pqszSh1aCyJvyl6cjQLT8CAwEAAQ==\\n-----END PUBLIC KEY-----\\n"
Return type
Example data
Content-Type: application/json
{
"fingerprint" : "fingerprint",
"created_at" : "2020-06-22T09:37:23.523Z",
"id" : "id",
"expired_at" : "2020-06-22T09:37:23.523Z",
"created_by" : "created_by",
"key" : "key"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Public Key added successfully.
PublicKey
400
Bad input provided.
HumanitecErrorResponse
403
Forbidden, only administrators can create new public key.
HumanitecErrorResponse
409
A public key with the same value already exists.
HumanitecErrorResponse
Up
delete /orgs/{orgId}/keys/{keyId}
Delete a public key associated to an organization. (deletePublicKey)
Path parameters
orgId (required)
Path Parameter — The organization ID.
keyId (required)
Path Parameter — The public key ID.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Public Key successfully removed.
403
Forbidden, only administrators can delete public keys.
HumanitecErrorResponse
404
Public key not found.
HumanitecErrorResponse
Up
get /orgs/{orgId}/keys/{keyId}
Retrieve a single public key associated to an organization. (getPublicKey)
Path parameters
orgId (required)
Path Parameter — The organization ID.
keyId (required)
Path Parameter — The public key ID.
Return type
Example data
Content-Type: application/json
{
"fingerprint" : "fingerprint",
"created_at" : "2020-06-22T09:37:23.523Z",
"id" : "id",
"expired_at" : "2020-06-22T09:37:23.523Z",
"created_by" : "created_by",
"key" : "key"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A public key associated to an organization.
PublicKey
404
Public key not found.
HumanitecErrorResponse
Up
get /orgs/{orgId}/keys
List all public keys associated to an organization. (getPublicKeys)
Path parameters
orgId (required)
Path Parameter — The organization ID.
Query parameters
fingerprint (optional)
Query Parameter — The fingerprint of the requested key. If a value is provided, the result will contain a single key, if any.
Return type
Example data
Content-Type: application/json
[ {
"fingerprint" : "fingerprint",
"created_at" : "2020-06-22T09:37:23.523Z",
"id" : "id",
"expired_at" : "2020-06-22T09:37:23.523Z",
"created_by" : "created_by",
"key" : "key"
}, {
"fingerprint" : "fingerprint",
"created_at" : "2020-06-22T09:37:23.523Z",
"id" : "id",
"expired_at" : "2020-06-22T09:37:23.523Z",
"created_by" : "created_by",
"key" : "key"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possible empty list of public keys associated to an organization, sorted descending by creation date.
400
Provided fingerprint is not valid.
HumanitecErrorResponse
Up
get /orgs/{orgId}/registries
Lists available registries for the organization. (orgsOrgIdRegistriesGet)
Path parameters
orgId (required)
Path Parameter — Unique (alpha-numerical) organization identifier.
Return type
Example data
Content-Type: application/json
[ {
"created_at" : "2020-05-22T14:53:27Z",
"created_by" : "a.user@example.com",
"enable_ci" : false,
"id" : "humanitec",
"registry" : "registry.humanitec.io",
"secrets" : {
"*" : {
"namespace" : "dev-secrets",
"secret" : "custom-regcred"
},
"cluster-A" : {
"namespace" : "prod-secrets",
"secret" : "custom-regcred"
}
},
"type" : "basic"
}, {
"created_at" : "2020-05-22T14:53:27Z",
"created_by" : "a.user@example.com",
"enable_ci" : false,
"id" : "humanitec",
"registry" : "registry.humanitec.io",
"secrets" : {
"*" : {
"namespace" : "dev-secrets",
"secret" : "custom-regcred"
},
"cluster-A" : {
"namespace" : "prod-secrets",
"secret" : "custom-regcred"
}
},
"type" : "basic"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A Possibly empty list of Registries.
400
Request parameters are incomplete or invalid.
ErrorInfoResponse
404
Specified 'orgId' does not match any record.
ErrorInfoResponse
Up
post /orgs/{orgId}/registries
Creates a new registry record. (orgsOrgIdRegistriesPost)
Path parameters
orgId (required)
Path Parameter — Unique (alpha-numerical) organization identifier.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — A new record details.
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-05-22T14:53:27Z",
"created_by" : "a.user@example.com",
"enable_ci" : false,
"id" : "humanitec",
"registry" : "registry.humanitec.io",
"secrets" : {
"*" : {
"namespace" : "dev-secrets",
"secret" : "custom-regcred"
},
"cluster-A" : {
"namespace" : "prod-secrets",
"secret" : "custom-regcred"
}
},
"type" : "basic"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
A newly created record details.
RegistryResponse
400
Request parameters or payload are incomplete or invalid.
ErrorInfoResponse
401
Authentication token is missing or invalid.
ErrorInfoResponse
404
Specified 'orgId' does not match any record.
ErrorInfoResponse
409
The record with the same ID or name (prefix) already exists within the organization.
ErrorInfoResponse
Up
get /orgs/{orgId}/registries/{regId}/creds
Returns current account credentials or secret details for the registry. (orgsOrgIdRegistriesRegIdCredsGet)
Path parameters
orgId (required)
Path Parameter — Unique (alpha-numerical) organization identifier.
regId (required)
Path Parameter — Unique (alpha-numerical) registry identifier.
Return type
Example data
Content-Type: application/json
{
"expires" : "2020-05-22T14:53:27Z",
"password" : "",
"registry" : "registry.io/project",
"secrets" : {
"*" : {
"namespace" : "dev-secrets",
"secret" : "custom-regcred"
},
"cluster-A" : {
"namespace" : "prod-secrets",
"secret" : "custom-regcred"
}
},
"username" : ""
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Current account credentials or secret details for the registry.
RegistryCredsResponse
400
Request parameters are incomplete or invalid.
ErrorInfoResponse
401
Authentication token is missing or invalid.
ErrorInfoResponse
404
Specified 'orgId' or 'regId' do not match any record.
ErrorInfoResponse
Up
delete /orgs/{orgId}/registries/{regId}
Deletes an existing registry record and all associated credentials and secrets. (orgsOrgIdRegistriesRegIdDelete)
Deletions are currently irreversible.
Path parameters
orgId (required)
Path Parameter — Unique (alpha-numerical) organization identifier.
regId (required)
Path Parameter — Unique (alpha-numerical) registry identifier.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Deleted successfully.
400
Request parameters are incomplete or invalid.
ErrorInfoResponse
403
Built-in 'humanitec' registry can't be deleted.
ErrorInfoResponse
404
Specified 'orgId' or 'regId' do not match any record.
ErrorInfoResponse
Up
get /orgs/{orgId}/registries/{regId}
Loads a registry record details. (orgsOrgIdRegistriesRegIdGet)
Path parameters
orgId (required)
Path Parameter — Unique (alpha-numerical) organization identifier.
regId (required)
Path Parameter — Unique (alpha-numerical) registry identifier.
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-05-22T14:53:27Z",
"created_by" : "a.user@example.com",
"enable_ci" : false,
"id" : "humanitec",
"registry" : "registry.humanitec.io",
"secrets" : {
"*" : {
"namespace" : "dev-secrets",
"secret" : "custom-regcred"
},
"cluster-A" : {
"namespace" : "prod-secrets",
"secret" : "custom-regcred"
}
},
"type" : "basic"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
A registry details.
RegistryResponse
400
Request parameters are incomplete or invalid.
ErrorInfoResponse
404
Specified 'orgId' or 'regId' do not match any record.
ErrorInfoResponse
Up
patch /orgs/{orgId}/registries/{regId}
Updates (patches) an existing registry record. (orgsOrgIdRegistriesRegIdPatch)
Path parameters
orgId (required)
Path Parameter — Unique (alpha-numerical) organization identifier.
regId (required)
Path Parameter — Unique (alpha-numerical) registry identifier.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Record details to update.
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-05-22T14:53:27Z",
"created_by" : "a.user@example.com",
"enable_ci" : false,
"id" : "humanitec",
"registry" : "registry.humanitec.io",
"secrets" : {
"*" : {
"namespace" : "dev-secrets",
"secret" : "custom-regcred"
},
"cluster-A" : {
"namespace" : "prod-secrets",
"secret" : "custom-regcred"
}
},
"type" : "basic"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Updated record details.
RegistryResponse
400
Request parameters or payload are incomplete or invalid.
ErrorInfoResponse
403
Built-in 'humanitec' registry can't be changed.
ErrorInfoResponse
404
Specified 'orgId' or 'regId' do not match any record.
ErrorInfoResponse
409
The record with the same name (prefix) already exists within the organization.
ErrorInfoResponse
Up
delete /orgs/{orgId}/resources/accounts/{accId}
Delete an unused Resource Account. (orgsOrgIdResourcesAccountsAccIdDelete)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
accId (required)
Path Parameter — The Resource Account ID.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
The account was successfully deleted.
400
One or more request parameters is missing or invalid.
HumanitecErrorResponse
404
A Resource Account with the 'accId' ID is not found or does not belong to the organization.
HumanitecErrorResponse
500
Internal application error.
HumanitecErrorResponse
Up
get /orgs/{orgId}/resources/accounts/{accId}
Get a Resource Account. (orgsOrgIdResourcesAccountsAccIdGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
accId (required)
Path Parameter — The Resource Account ID.
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "test-user",
"id" : "gcp-dev-postgres",
"is_default" : false,
"is_used" : true,
"name" : "GCP Dev Postgres",
"type" : "gcp"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The requested Resources Account.
ResourceAccountResponse
404
A Resource Account with the 'accId' ID is not found or does not belong to the organization.
HumanitecErrorResponse
500
Internal application error.
HumanitecErrorResponse
Up
patch /orgs/{orgId}/resources/accounts/{accId}
Update a Resource Account. (orgsOrgIdResourcesAccountsAccIdPatch)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
accId (required)
Path Parameter — The Resource Account ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "test-user",
"id" : "gcp-dev-postgres",
"is_default" : false,
"is_used" : true,
"name" : "GCP Dev Postgres",
"type" : "gcp"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The updated Resource Account details.
ResourceAccountResponse
400
One or more request parameters is missing or invalid.
HumanitecErrorResponse
404
A Resource Account with the 'accId' ID is not found or does not belong to the organization.
HumanitecErrorResponse
500
Internal application error.
HumanitecErrorResponse
Up
get /orgs/{orgId}/resources/accounts
List Resource Accounts in the organization. (orgsOrgIdResourcesAccountsGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Return type
Example data
Content-Type: application/json
[ {
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "test-user",
"id" : "gcp-dev-postgres",
"is_default" : false,
"is_used" : true,
"name" : "GCP Dev Postgres",
"type" : "gcp"
}, {
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "test-user",
"id" : "gcp-dev-postgres",
"is_default" : false,
"is_used" : true,
"name" : "GCP Dev Postgres",
"type" : "gcp"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty list of Resources Accounts.
500
Internal application error.
HumanitecErrorResponse
Up
post /orgs/{orgId}/resources/accounts
Create a new Resource Account in the organization. (orgsOrgIdResourcesAccountsPost)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-05-22T14:58:07Z",
"created_by" : "test-user",
"id" : "gcp-dev-postgres",
"is_default" : false,
"is_used" : true,
"name" : "GCP Dev Postgres",
"type" : "gcp"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The newly created Resources Account details.
ResourceAccountResponse
400
One or more request parameters is missing or invalid.
HumanitecErrorResponse
401
Authentication token is missing or invalid.
HumanitecErrorResponse
409
A Resources Account already exists.
HumanitecErrorResponse
500
Internal application error.
HumanitecErrorResponse
Up
delete /orgs/{orgId}/resources/defs/{defId}/criteria/{criteriaId}
Delete a Matching Criteria from a Resource Definition. (orgsOrgIdResourcesDefsDefIdCriteriaCriteriaIdDelete)
If there are no Active Resources that would match to a different Resource Definition when the current Matching Criteria is deleted, the Matching Criteria is deleted immediately.
If there are Active Resources that would match to a different Resource Definition, the request fails with HTTP status code 409 (Conflict). The response content will list all of affected Active Resources and their new matches.
The request can take an optional force query parameter. If set to true, the Matching Criteria is deleted immediately. Referenced Active Resources would match to a different Resource Definition during the next deployment in the target environment.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
defId (required)
Path Parameter — The Resource Definition ID.
criteriaId (required)
Path Parameter — The Matching Criteria ID.
Query parameters
force (optional)
Query Parameter — If set to <code>true</code>, the Matching Criteria is deleted immediately, even if this action affects existing Active Resources.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Record deleted.
404
The Resource Definition is not found.
String
409
One or more Active Resources reference the Resource Definition through this Matching Criteria.
500
Internal application error.
HumanitecErrorResponse
Up
post /orgs/{orgId}/resources/defs/{defId}/criteria
Add a new Matching Criteria to a Resource Definition. (orgsOrgIdResourcesDefsDefIdCriteriaPost)
Matching Criteria are combined with Resource Type to select a specific definition. Matching Criteria can be set for any combination of Application ID, Environment ID, Environment Type, and Resource ID. In the event of multiple matches, the most specific match is chosen.
For example, given 3 sets of matching criteria for the same type:
1. {"env_type":"test"}
2. {"env_type":"development"}
3. {"env_type":"test", "app_id":"my-app"}
If, a resource of that time was needed in an Application my-app, Environment qa-team with Type test and Resource ID modules.my-module-externals.my-resource, there would be two resource definitions matching the criteria: #1 & #3. Definition #3 will be chosen because its matching criteria is the most specific.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
defId (required)
Path Parameter — The Resource Definition ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Matching Criteria rules.
example: {
"env_id" : "production"
}
Return type
Example data
Content-Type: application/json
{
"env_id" : "env_id",
"res_id" : "res_id",
"id" : "id",
"app_id" : "app_id",
"class" : "class",
"env_type" : "env_type"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The newly added Matching Criteria details.
MatchingCriteriaResponse
400
One or more request parameters is missing or invalid.
HumanitecErrorResponse
409
A Matching Criteria already exists.
HumanitecErrorResponse
500
Internal application error.
HumanitecErrorResponse
Up
delete /orgs/{orgId}/resources/defs/{defId}
Delete a Resource Definition. (orgsOrgIdResourcesDefsDefIdDelete)
If there are no Active Resources provisioned via the current definition, the Resource Definition is deleted immediately.
If there are Active Resources provisioned via the current definition, the request fails. The response will describe the changes to the affected Active Resources if operation is forced.
The request can take an optional force query parameter. If set to true, the current Resource Definition is marked as pending deletion and will be deleted (purged) as soon as no existing Active Resources reference it. With the next deployment matching criteria for Resources will be re-evaluated, and current Active Resources for the target environment would be either linked to another matching Resource Definition or decommissioned and created using the new or default Resource Definition (when available).
The Resource Definition that has been marked for deletion cannot be used to provision new resources.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
defId (required)
Path Parameter — The Resource Definition ID.
Query parameters
force (optional)
Query Parameter — If set to <code>true</code>, will mark the Resource Definition for deletion, even if it affects existing Active Resources.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Resource Definition has been marked for deletion.
404
A Resource Driver with the 'driverId' ID is not found or is not accessible by the organization.
HumanitecErrorResponse
409
List of Active Resources that still reference this Resource Definition.
500
Internal application error.
HumanitecErrorResponse
Up
get /orgs/{orgId}/resources/defs/{defId}
Get a specific Resource Definition. (orgsOrgIdResourcesDefsDefIdGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
defId (required)
Path Parameter — The Resource Definition ID.
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-05-23T12:32:16Z",
"created_by" : "a.user@example.com",
"criteria" : [ {
"env_type" : "development",
"id" : "123456"
} ],
"driver_account" : "gcp-dev-cloudsql",
"driver_inputs" : {
"secret_refs" : {
"credentials" : {
"password" : {
"value" : ""
},
"user" : {
"ref" : "vault/path/to/data/secrets/user",
"store" : "my-external-vault",
"version" : "1"
}
}
},
"values" : {
"instance" : "my-dev-project:my-region:dev-db"
}
},
"driver_type" : "humanitec/postgres-cloudsql",
"id" : "dev-postgres",
"is_default" : false,
"is_deleted" : false,
"name" : "Dev Postgres Instance",
"org_id" : "test-org",
"provision" : {
"aws-policy" : {
"is_dependent" : false,
"match_dependents" : false
},
"dns#my-dns" : { }
},
"type" : "postgres"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The requested Resources Definition details.
ResourceDefinitionResponse
404
A Resource Definition with the 'defId' ID is not found.
HumanitecErrorResponse
500
Internal application error.
HumanitecErrorResponse
Up
patch /orgs/{orgId}/resources/defs/{defId}
Update a Resource Definition. (orgsOrgIdResourcesDefsDefIdPatch)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
defId (required)
Path Parameter — The Resource Definition ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — <p>The Resource Definition record details.</p>
<p>The PATCH operation would change the value of the property if it is included in the request payload JSON, and not <code>null</code>. Missing and <code>null</code> properties are ignored.</p>
<p>For the map properties, such as PatchResourceDefinitionRequest.DriverInputs, the merge operation is applied.</p>
<p>Merge rules are as follows:</p>
<ul>
<li>
<p>If a map property has a value, it is replaced (or added).</p>
</li>
<li>
<p>If a map property is set to <code>null</code>, it is removed.</p>
</li>
<li>
<p>If a map property is not included (missing in JSON), it remains unchanged.</p>
</li>
</ul>
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-05-23T12:32:16Z",
"created_by" : "a.user@example.com",
"criteria" : [ {
"env_type" : "development",
"id" : "123456"
} ],
"driver_account" : "gcp-dev-cloudsql",
"driver_inputs" : {
"secret_refs" : {
"credentials" : {
"password" : {
"value" : ""
},
"user" : {
"ref" : "vault/path/to/data/secrets/user",
"store" : "my-external-vault",
"version" : "1"
}
}
},
"values" : {
"instance" : "my-dev-project:my-region:dev-db"
}
},
"driver_type" : "humanitec/postgres-cloudsql",
"id" : "dev-postgres",
"is_default" : false,
"is_deleted" : false,
"name" : "Dev Postgres Instance",
"org_id" : "test-org",
"provision" : {
"aws-policy" : {
"is_dependent" : false,
"match_dependents" : false
},
"dns#my-dns" : { }
},
"type" : "postgres"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The updated Resource Definition.
ResourceDefinitionResponse
400
One or more request parameters is missing or invalid.
HumanitecErrorResponse
404
A Resource Definition with the 'defId' ID is not found.
HumanitecErrorResponse
500
Internal application error.
HumanitecErrorResponse
Up
put /orgs/{orgId}/resources/defs/{defId}
Update a Resource Definition. (orgsOrgIdResourcesDefsDefIdPut)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
defId (required)
Path Parameter — The Resource Definition ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — <p>The Resource Definition record details.</p>
<p>The PUT operation updates a resource definition using the provided payload. An empty driver_account or driver_inputs property will unset the existing values.</p>
<p>Currently the resource and driver types can't be changed.</p>
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-05-23T12:32:16Z",
"created_by" : "a.user@example.com",
"criteria" : [ {
"env_type" : "development",
"id" : "123456"
} ],
"driver_account" : "gcp-dev-cloudsql",
"driver_inputs" : {
"secret_refs" : {
"credentials" : {
"password" : {
"value" : ""
},
"user" : {
"ref" : "vault/path/to/data/secrets/user",
"store" : "my-external-vault",
"version" : "1"
}
}
},
"values" : {
"instance" : "my-dev-project:my-region:dev-db"
}
},
"driver_type" : "humanitec/postgres-cloudsql",
"id" : "dev-postgres",
"is_default" : false,
"is_deleted" : false,
"name" : "Dev Postgres Instance",
"org_id" : "test-org",
"provision" : {
"aws-policy" : {
"is_dependent" : false,
"match_dependents" : false
},
"dns#my-dns" : { }
},
"type" : "postgres"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The updated Resource Definition.
ResourceDefinitionResponse
400
One or more request parameters is missing or invalid.
HumanitecErrorResponse
404
A Resource Definition with the 'defId' ID is not found.
HumanitecErrorResponse
500
Internal application error.
HumanitecErrorResponse
Up
get /orgs/{orgId}/resources/defs/{defId}/resources
List Active Resources provisioned via a specific Resource Definition. (orgsOrgIdResourcesDefsDefIdResourcesGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
defId (required)
Path Parameter — The Resource Definition ID.
Return type
Example data
Content-Type: application/json
[ {
"app_id" : "test-app",
"class" : "default",
"def_id" : "gcp-dev-postgres",
"deploy_id" : "172a1013b",
"env_id" : "gcp-dev",
"env_type" : "development",
"gu_res_id" : "7bd3966c9ff8eaa66c5cce855c03d715857c3440",
"org_id" : "test-org",
"res_id" : "modules.my-module.externals.my-db",
"resource" : {
"values" : {
"host" : "127.0.0.1",
"name" : "db_33c7ef9b_8d90-4c62_a1cf_0cdd30fd29a9",
"port" : 5432
}
},
"type" : "postgres",
"updated_at" : "2020-06-23T16:53:12Z"
}, {
"app_id" : "test-app",
"class" : "default",
"def_id" : "gcp-dev-postgres",
"deploy_id" : "172a1013b",
"env_id" : "gcp-dev",
"env_type" : "development",
"gu_res_id" : "7bd3966c9ff8eaa66c5cce855c03d715857c3440",
"org_id" : "test-org",
"res_id" : "modules.my-module.externals.my-db",
"resource" : {
"values" : {
"host" : "127.0.0.1",
"name" : "db_33c7ef9b_8d90-4c62_a1cf_0cdd30fd29a9",
"port" : 5432
}
},
"type" : "postgres",
"updated_at" : "2020-06-23T16:53:12Z"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty list of Active Resources.
500
Internal application error.
HumanitecErrorResponse
Up
get /orgs/{orgId}/resources/defs
List Resource Definitions. (orgsOrgIdResourcesDefsGet)
Filter criteria can be applied to obtain all the resource definitions that could match the filters, grouped by type and sorted by matching rank.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Query parameters
app (optional)
Query Parameter — (Optional) Filter Resource Definitions that may match a specific Application.
env (optional)
Query Parameter — (Optional) Filter Resource Definitions that may match a specific Environment.
env_type (optional)
Query Parameter — (Optional) Filter Resource Definitions that may match a specific Environment Type.
res (optional)
Query Parameter — (Optional) Filter Resource Definitions that may match a specific Resource.
res_type (optional)
Query Parameter — (Optional) Filter Resource Definitions that may match a specific Resource Type.
class (optional)
Query Parameter — (Optional) Filter Resource Definitions that may match a specific Class.
Return type
Example data
Content-Type: application/json
[ {
"created_at" : "2020-05-23T12:32:16Z",
"created_by" : "a.user@example.com",
"criteria" : [ {
"env_type" : "development",
"id" : "123456"
} ],
"driver_account" : "gcp-dev-cloudsql",
"driver_inputs" : {
"secret_refs" : {
"credentials" : {
"password" : {
"value" : ""
},
"user" : {
"ref" : "vault/path/to/data/secrets/user",
"store" : "my-external-vault",
"version" : "1"
}
}
},
"values" : {
"instance" : "my-dev-project:my-region:dev-db"
}
},
"driver_type" : "humanitec/postgres-cloudsql",
"id" : "dev-postgres",
"is_default" : false,
"is_deleted" : false,
"name" : "Dev Postgres Instance",
"org_id" : "test-org",
"provision" : {
"aws-policy" : {
"is_dependent" : false,
"match_dependents" : false
},
"dns#my-dns" : { }
},
"type" : "postgres"
}, {
"created_at" : "2020-05-23T12:32:16Z",
"created_by" : "a.user@example.com",
"criteria" : [ {
"env_type" : "development",
"id" : "123456"
} ],
"driver_account" : "gcp-dev-cloudsql",
"driver_inputs" : {
"secret_refs" : {
"credentials" : {
"password" : {
"value" : ""
},
"user" : {
"ref" : "vault/path/to/data/secrets/user",
"store" : "my-external-vault",
"version" : "1"
}
}
},
"values" : {
"instance" : "my-dev-project:my-region:dev-db"
}
},
"driver_type" : "humanitec/postgres-cloudsql",
"id" : "dev-postgres",
"is_default" : false,
"is_deleted" : false,
"name" : "Dev Postgres Instance",
"org_id" : "test-org",
"provision" : {
"aws-policy" : {
"is_dependent" : false,
"match_dependents" : false
},
"dns#my-dns" : { }
},
"type" : "postgres"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty list of Resources Definitions.
500
Internal application error.
HumanitecErrorResponse
Up
post /orgs/{orgId}/resources/defs
Create a new Resource Definition. (orgsOrgIdResourcesDefsPost)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The Resource Definition details.
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-05-23T12:32:16Z",
"created_by" : "a.user@example.com",
"criteria" : [ {
"env_type" : "development",
"id" : "123456"
} ],
"driver_account" : "gcp-dev-cloudsql",
"driver_inputs" : {
"secret_refs" : {
"credentials" : {
"password" : {
"value" : ""
},
"user" : {
"ref" : "vault/path/to/data/secrets/user",
"store" : "my-external-vault",
"version" : "1"
}
}
},
"values" : {
"instance" : "my-dev-project:my-region:dev-db"
}
},
"driver_type" : "humanitec/postgres-cloudsql",
"id" : "dev-postgres",
"is_default" : false,
"is_deleted" : false,
"name" : "Dev Postgres Instance",
"org_id" : "test-org",
"provision" : {
"aws-policy" : {
"is_dependent" : false,
"match_dependents" : false
},
"dns#my-dns" : { }
},
"type" : "postgres"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The newly created Resources Definition details.
ResourceDefinitionResponse
400
One or more request parameters is missing or invalid.
HumanitecErrorResponse
409
A Resources Definition already exists.
HumanitecErrorResponse
500
Internal application error.
HumanitecErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/envs/{envId}/resources/graph
Lists the resource objects that hold the information needed to provision the resources specified in the request and the resources they depend on. (orgsOrgIdAppsAppIdEnvsEnvIdResourcesGraphPost)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Resources to provision.
Return type
Example data
Content-Type: application/json
[ {
"class" : "default",
"criteria_id" : "09876545321",
"def_id" : "dns-res-def",
"depends_on" : [ "ff09876545321" ],
"driver" : {
"secrets" : { },
"values" : {
"domain" : "my-domain"
}
},
"driver_type" : "humanitec/dns-aws-route53",
"guresid" : "1234567890ff",
"id" : "modules.sample-app.my-dns",
"resource" : null,
"resource_schema" : {
"properties" : {
"host" : {
"type" : "string"
}
},
"type" : "object"
},
"type" : "dns"
}, {
"class" : "default",
"criteria_id" : "09876545321",
"def_id" : "dns-res-def",
"depends_on" : [ "ff09876545321" ],
"driver" : {
"secrets" : { },
"values" : {
"domain" : "my-domain"
}
},
"driver_type" : "humanitec/dns-aws-route53",
"guresid" : "1234567890ff",
"id" : "modules.sample-app.my-dns",
"resource" : null,
"resource_schema" : {
"properties" : {
"host" : {
"type" : "string"
}
},
"type" : "object"
},
"type" : "dns"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A list of objects which hold information to provision resources, sorted according to resources provisioning order.
400
Request payload is not provided or is malformed.
HumanitecErrorResponse
500
Internal application error.
HumanitecErrorResponse
Up
get /orgs/{orgId}/resources/types
List Resource Types. (orgsOrgIdResourcesTypesGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Return type
Example data
Content-Type: application/json
[ {
"inputs_schema" : {
"values" : {
"properties" : {
"extensions" : {
"additionalProperties" : {
"properties" : {
"schema" : {
"type" : "string"
},
"version" : {
"type" : "string"
}
},
"type" : "object"
}
}
},
"type" : "object"
}
},
"name" : "PostgreSQL",
"outputs_schema" : {
"secrets" : {
"properties" : {
"password" : {
"type" : "string"
},
"username" : {
"type" : "string"
}
},
"required" : [ "username", "password" ],
"type" : "object"
},
"values" : {
"properties" : {
"host" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"port" : {
"maximum" : 65535,
"minimum" : 0,
"type" : "integer"
}
},
"required" : [ "name", "host", "port" ],
"type" : "object"
}
},
"type" : "postgres",
"use" : "direct"
}, {
"inputs_schema" : {
"values" : {
"properties" : {
"extensions" : {
"additionalProperties" : {
"properties" : {
"schema" : {
"type" : "string"
},
"version" : {
"type" : "string"
}
},
"type" : "object"
}
}
},
"type" : "object"
}
},
"name" : "PostgreSQL",
"outputs_schema" : {
"secrets" : {
"properties" : {
"password" : {
"type" : "string"
},
"username" : {
"type" : "string"
}
},
"required" : [ "username", "password" ],
"type" : "object"
},
"values" : {
"properties" : {
"host" : {
"type" : "string"
},
"name" : {
"type" : "string"
},
"port" : {
"maximum" : 65535,
"minimum" : 0,
"type" : "integer"
}
},
"required" : [ "name", "host", "port" ],
"type" : "object"
}
},
"type" : "postgres",
"use" : "direct"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty list of Resources Types.
500
Internal application error.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/envs/{envId}/runtime
Get Runtime information about the environment. (orgsOrgIdAppsAppIdEnvsEnvIdRuntimeGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
Return type
Example data
Content-Type: application/json
{
"namespace" : "namespace",
"modules" : {
"key" : {
"key" : {
"kind" : "kind",
"replicas" : 6,
"pods" : [ {
"phase" : "phase",
"containerStatuses" : [ "", "" ],
"podName" : "podName",
"revision" : 0,
"status" : "status"
}, {
"phase" : "phase",
"containerStatuses" : [ "", "" ],
"podName" : "podName",
"revision" : 0,
"status" : "status"
} ],
"message" : "message",
"revision" : 1,
"status" : "status"
}
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Runtime info returned.
RuntimeInfoResponse
400
Cluster not well configured or unreachable.
HumanitecErrorResponse
404
Environment not found.
HumanitecErrorResponse
Up
put /orgs/{orgId}/apps/{appId}/envs/{envId}/runtime/paused
Pause / Resume an environment. (orgsOrgIdAppsAppIdEnvsEnvIdRuntimePausedPut)
On pause requests, all the Kubernetes Deployment resources are scaled down to 0 replicas.
On resume requests, all the Kubernetes Deployment resources are scaled up to the number of replicas running before the environment was paused.
When an environment is paused, it is not possible to:
- Deploy the environment within Humanitec.
- Scale the number of replicas running of any workload.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — If the value is <code>true</code> the request is to pause an environment, if it is <code>false</code> is to resume an environment.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Success.
400
Missing or malformed input.
HumanitecErrorResponse
403
Forbidden (insufficient privileges to perform the action).
HumanitecErrorResponse
404
Environment not found.
HumanitecErrorResponse
Up
patch /orgs/{orgId}/apps/{appId}/envs/{envId}/runtime/replicas
Set number of replicas for an environment's modules. (orgsOrgIdAppsAppIdEnvsEnvIdRuntimeReplicasPatch)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — map of replicas by modules.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Success.
400
Missing or malformed input.
HumanitecErrorResponse
403
Forbidden (default cluster limitations or insufficient privileges to perform the action).
HumanitecErrorResponse
404
Environment not found.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/runtime
Get Runtime information about specific environments. (orgsOrgIdAppsAppIdRuntimeGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Query parameters
id (optional)
Query Parameter — Filter environments by ID (required). Up to 5 ids can be supplied per request.
Return type
Example data
Content-Type: application/json
[ {
"paused" : true,
"id" : "id",
"error" : "error",
"status" : "status"
}, {
"paused" : true,
"id" : "id",
"error" : "error",
"status" : "status"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A list of the RuntimeInfo of the environments specified by the id parameter.
Example data
Content-Type: application/json
[{"id":"development","paused":true,"status":"Success"},{"id":"staging","paused":false,"status":"Warning"},{"error":"Environment my-org/my-app/not-existing-env does not exist","id":"not-existing-env","paused":false}]
400
Bad Request.
HumanitecErrorResponse
Up
get /orgs/{orgId}/secretstores
Get list of Secret Stores for the given organization. (orgsOrgIdSecretstoresGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Return type
Example data
Content-Type: application/json
[ {
"gcpsm" : {
"project_id" : "project_id"
},
"updated_at" : "2020-06-22T09:37:23.523Z",
"humanitec" : { },
"updated_by" : "updated_by",
"awssm" : {
"endpoint" : "endpoint",
"region" : "region"
},
"created_at" : "2020-06-22T09:37:23.523Z",
"azurekv" : {
"tenant_id" : "tenant_id",
"url" : "url"
},
"id" : "id",
"created_by" : "created_by",
"vault" : {
"path" : "path",
"agent_id" : "agent_id",
"url" : "url"
},
"primary" : true
}, {
"gcpsm" : {
"project_id" : "project_id"
},
"updated_at" : "2020-06-22T09:37:23.523Z",
"humanitec" : { },
"updated_by" : "updated_by",
"awssm" : {
"endpoint" : "endpoint",
"region" : "region"
},
"created_at" : "2020-06-22T09:37:23.523Z",
"azurekv" : {
"tenant_id" : "tenant_id",
"url" : "url"
},
"id" : "id",
"created_by" : "created_by",
"vault" : {
"path" : "path",
"agent_id" : "agent_id",
"url" : "url"
},
"primary" : true
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
List of Secret Stores.
Up
post /orgs/{orgId}/secretstores
Create a Secret Store for the given organization. (orgsOrgIdSecretstoresPost)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Secret Store data.
Return type
Example data
Content-Type: application/json
{
"gcpsm" : {
"project_id" : "project_id"
},
"updated_at" : "2020-06-22T09:37:23.523Z",
"humanitec" : { },
"updated_by" : "updated_by",
"awssm" : {
"endpoint" : "endpoint",
"region" : "region"
},
"created_at" : "2020-06-22T09:37:23.523Z",
"azurekv" : {
"tenant_id" : "tenant_id",
"url" : "url"
},
"id" : "id",
"created_by" : "created_by",
"vault" : {
"path" : "path",
"agent_id" : "agent_id",
"url" : "url"
},
"primary" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Secret Store successfully added.
SecretStoreResponse
400
One or more request body parameters are either missing, invalid, or the requested payload is not provided or is malformed.
HumanitecErrorResponse
401
Request unauthorised.
HumanitecErrorResponse
409
Conflict.
HumanitecErrorResponse
Up
delete /orgs/{orgId}/secretstores/{storeId}
Delete the Secret Store. (orgsOrgIdSecretstoresStoreIdDelete)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
storeId (required)
Path Parameter — The Secret Store ID.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Secret Store successfully deleted.
404
Secret Store not found.
HumanitecErrorResponse
Up
get /orgs/{orgId}/secretstores/{storeId}
Get the Secret Store. (orgsOrgIdSecretstoresStoreIdGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
storeId (required)
Path Parameter — The Secret Store ID.
Return type
Example data
Content-Type: application/json
{
"gcpsm" : {
"project_id" : "project_id"
},
"updated_at" : "2020-06-22T09:37:23.523Z",
"humanitec" : { },
"updated_by" : "updated_by",
"awssm" : {
"endpoint" : "endpoint",
"region" : "region"
},
"created_at" : "2020-06-22T09:37:23.523Z",
"azurekv" : {
"tenant_id" : "tenant_id",
"url" : "url"
},
"id" : "id",
"created_by" : "created_by",
"vault" : {
"path" : "path",
"agent_id" : "agent_id",
"url" : "url"
},
"primary" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Returns Secret Stores.
SecretStoreResponse
404
Secret Store not found.
HumanitecErrorResponse
Up
patch /orgs/{orgId}/secretstores/{storeId}
Update the Secret Store. (orgsOrgIdSecretstoresStoreIdPatch)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
storeId (required)
Path Parameter — The Secret Store ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Secret Store data.
Return type
Example data
Content-Type: application/json
{
"gcpsm" : {
"project_id" : "project_id"
},
"updated_at" : "2020-06-22T09:37:23.523Z",
"humanitec" : { },
"updated_by" : "updated_by",
"awssm" : {
"endpoint" : "endpoint",
"region" : "region"
},
"created_at" : "2020-06-22T09:37:23.523Z",
"azurekv" : {
"tenant_id" : "tenant_id",
"url" : "url"
},
"id" : "id",
"created_by" : "created_by",
"vault" : {
"path" : "path",
"agent_id" : "agent_id",
"url" : "url"
},
"primary" : true
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Secret Store successfully updated.
SecretStoreResponse
400
One or more request body parameters are either missing, invalid, or the requested payload is not provided or is malformed.
HumanitecErrorResponse
404
Secret Store not found.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/sets
Get all Deployment Sets (getSets)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Return type
Example data
Content-Type: application/json
[ {
"modules" : {
"module-one" : {
"externals" : {
"db-one" : {
"params" : {
"extensions" : {
"uuid-ossp" : { }
}
},
"type" : "postgres"
}
},
"profile" : "humanitec/default-module",
"spec" : {
"containers" : {
"core-service" : {
"id" : "core-service",
"image" : "registry.humanitec.io/my-org/core-service:VERSION_ONE",
"readiness_probe" : {
"path" : "/healtz",
"port" : 8080,
"type" : "http"
},
"variables" : {
"DBHOST" : "${externals.db-one.name}",
"DBNAME" : "${externals.db-one.name}",
"DBPASSWORD" : "${externals.db-one.password}",
"DBUSERNAME" : "${externals.db-one.username}",
"REDIS_URL" : "redis://${modules.redis-cache.service.name}"
}
}
}
}
},
"redis-cache" : {
"profile" : "humanitec/redis"
}
}
}, {
"modules" : {
"module-one" : {
"externals" : {
"db-one" : {
"params" : {
"extensions" : {
"uuid-ossp" : { }
}
},
"type" : "postgres"
}
},
"profile" : "humanitec/default-module",
"spec" : {
"containers" : {
"core-service" : {
"id" : "core-service",
"image" : "registry.humanitec.io/my-org/core-service:VERSION_ONE",
"readiness_probe" : {
"path" : "/healtz",
"port" : 8080,
"type" : "http"
},
"variables" : {
"DBHOST" : "${externals.db-one.name}",
"DBNAME" : "${externals.db-one.name}",
"DBPASSWORD" : "${externals.db-one.password}",
"DBUSERNAME" : "${externals.db-one.username}",
"REDIS_URL" : "redis://${modules.redis-cache.service.name}"
}
}
}
}
},
"redis-cache" : {
"profile" : "humanitec/redis"
}
}
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The Requested Deployment Set.
404
No Deployment Set with ID <code>setId</code> found in Application.
String
Up
get /orgs/{orgId}/apps/{appId}/sets/{setId}/diff/{sourceSetId}
Get the difference between 2 Deployment Sets (orgsOrgIdAppsAppIdSetsSetIdDiffSourceSetIdGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
setId (required)
Path Parameter — ID of the Deployment Set.
sourceSetId (required)
Path Parameter — ID of the Deployment Set to diff against.
Return type
Example data
Content-Type: application/json
{
"modules" : {
"add" : {
"redis-cache" : {
"profile" : "humanitec/redis"
}
},
"remove" : [ "simple-service" ],
"update" : {
"module-one" : [ {
"op" : "replace",
"path" : "/spec/containers/core-service/variables/EXAMPLE",
"value" : "New Value"
} ]
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A Deployment Delta which if applied to the Set with ID <code>sourceSetId</code> gives the Set with ID <code>setId</code>.
PlainDeltaResponse
404
No Deployment Set with ID <code>setId</code> or <code>sourceSetId</code> found in Application.
String
Up
get /orgs/{orgId}/apps/{appId}/sets/{setId}
Get a Deployment Set (orgsOrgIdAppsAppIdSetsSetIdGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
setId (required)
Path Parameter — ID of the Deployment Set.
Query parameters
diff (optional)
Query Parameter — ID of the Deployment Set to compared against.
Return type
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The Requested Deployment Set.
inline_response_200_1
404
No Deployment Set with ID <code>setId</code> found in Application.
String
Up
post /orgs/{orgId}/apps/{appId}/sets/{setId}
Apply a Deployment Delta to a Deployment Set (orgsOrgIdAppsAppIdSetsSetIdPost)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
setId (required)
Path Parameter — ID of the Deployment Set.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — <p>The Delta to apply to the Set.</p>
<p>NOTE: The <code>id</code> parameter is ignored if provided. The request body should be the full Delta.</p>
example: {
"modules" : {
"remove" : [ "module-one" ]
}
}
Return type
String
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A Deployment Delta which if applied to the Set with ID <code>sourceSetId</code> gives the Set with ID <code>setId</code>.
String
400
Deployment Delta is incompatible with the Deployment Set specified by <code>setId</code>.
HumanitecErrorResponse
404
No Deployment Set with ID <code>setId</code> found in Application.
String
Up
get /users/{userId}/tokens
Lists tokens associated with a user (usersUserIdTokensGet)
Path parameters
userId (required)
Path Parameter — The user ID.
Return type
Example data
Content-Type: application/json
[ {
"created_at" : "2021-04-30T19:47:01Z",
"description" : "Humanitec API Calls from CircleCI Pipelines",
"expires_at" : "2022-04-30T19:47:01Z",
"id" : "circle-ci-token",
"type" : "static",
"user_id" : "a7a04740ae985f12af58545e4edbac6a"
}, {
"created_at" : "2021-04-30T19:47:01Z",
"description" : "Humanitec API Calls from CircleCI Pipelines",
"expires_at" : "2022-04-30T19:47:01Z",
"id" : "circle-ci-token",
"type" : "static",
"user_id" : "a7a04740ae985f12af58545e4edbac6a"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty list of tokens.
403
Calling user does not have permission to list tokens for this user.
Up
post /users/{userId}/tokens
Creates a new static token for a user. (usersUserIdTokensPost)
This is only supported for users of type service.
Path parameters
userId (required)
Path Parameter — The user ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The definition of the token.
Return type
Example data
Content-Type: application/json
{
"token" : "a7a04740ae985f12af58545e4edbac6a",
"type" : "jwt"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The issued static token.
TokenResponse
400
The request was invalid or the payload malformed.
HumanitecErrorResponse
403
Calling user does not have permission to list tokens for this user.
409
There is already a token with the given ID.
Up
delete /users/{userId}/tokens/{tokenId}
Deletes a specific token associated with a user (usersUserIdTokensTokenIdDelete)
This is only possible for static tokens. To revoke session tokens - use POST /auth/logout with the required session token.
Path parameters
userId (required)
Path Parameter — The user ID.
tokenId (required)
Path Parameter — The token ID.
Responses
204
The token was successfully deleted.
400
The request is invalid.
403
The calling user does not have permission to delete the token.
404
This token id is not available for the user or the user does not exist.
Up
get /users/{userId}/tokens/{tokenId}
Gets a specific token associated with a user (usersUserIdTokensTokenIdGet)
Path parameters
userId (required)
Path Parameter — The user ID.
tokenId (required)
Path Parameter — The token ID.
Return type
Example data
Content-Type: application/json
{
"created_at" : "2021-04-30T19:47:01Z",
"description" : "Humanitec API Calls from CircleCI Pipelines",
"expires_at" : "2022-04-30T19:47:01Z",
"id" : "circle-ci-token",
"type" : "static",
"user_id" : "a7a04740ae985f12af58545e4edbac6a"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Metadata about the token.
TokenInfoResponse
403
Calling user does not have permission to list tokens for this user.
404
This token ID is not available for the user.
Up
get /orgs/{orgId}/invitations
List the invites issued for the organization. (orgsOrgIdInvitationsGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Return type
Example data
Content-Type: application/json
[ {
"created_at" : "2020-12-19T09:32:46Z",
"created_by" : "admin-user-id",
"email" : "jo.trigg@awesomecorp.com",
"expires_at" : "2020-12-30T09:32:46Z",
"user_id" : "new-user-id"
}, {
"created_at" : "2020-12-19T09:32:46Z",
"created_by" : "admin-user-id",
"email" : "jo.trigg@awesomecorp.com",
"expires_at" : "2020-12-30T09:32:46Z",
"user_id" : "new-user-id"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The list of the invites issued for the organization.
Gets the extended profile of the current user (currentUserGet)
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "d510224a-4641-48fd-8054-68efd3537ee2",
"name" : "Jo Trigg",
"properties" : {
"dont_show_welcome_screen" : true
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The extended user profile of the user.
UserProfileExtendedResponse
401
No token supplied.
403
Token is not valid for a user.
Updates the extended profile of the current user. (currentUserPatch)
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "d510224a-4641-48fd-8054-68efd3537ee2",
"name" : "Jo Trigg",
"properties" : {
"dont_show_welcome_screen" : true
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The extended user profile of the user.
UserProfileExtendedResponse
400
The request was invalid or the payload malformed.
HumanitecErrorResponse
401
No token supplied.
403
Token is not valid for a user.
Up
post /orgs/{orgId}/users
Creates a new service user. (orgsOrgIdUsersPost)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The user ID and the role
example: {
"id" : "61048226-642c-438e-974f-ce5c013d94f8",
"role" : "manager",
"name" : "CI Robot"
}
Return type
Example data
Content-Type: application/json
{
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "d510224a-4641-48fd-8054-68efd3537ee2",
"name" : "Jo Trigg",
"type" : "user"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The extended user profile of the user.
UserProfileResponse
400
The request was invalid or the payload malformed.
HumanitecErrorResponse
422
The request body was not parseable.
403
Token is not valid for a user.
DEPRECATED (tokensGet)
Return type
map[String, Object]
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The token structure.
Up
delete /tokens/{tokenId}
DEPRECATED (tokensTokenIdDelete)
Path parameters
tokenId (required)
Path Parameter — The token ID
Responses
204
Deleted
DEPRECATED (usersMeGet)
Return type
map[String, Object]
Example data
Content-Type: application/json
""
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The extended user profile of the user.
401
No token supplied.
403
Token is not valid for a user.
Up
get /orgs/{orgId}/apps/{appId}/users
List Users with roles in an App (orgsOrgIdAppsAppIdUsersGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Return type
Example data
Content-Type: application/json
[ {
"role" : "manager",
"user" : "61048226-642c-438e-974f-ce5c013d94f8",
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "730c1f96-8ee5-4bff-8c22-898e0530b924",
"invite" : "accepted",
"name" : "Jo Trigg",
"type" : "user"
}, {
"role" : "manager",
"user" : "61048226-642c-438e-974f-ce5c013d94f8",
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "730c1f96-8ee5-4bff-8c22-898e0530b924",
"invite" : "accepted",
"name" : "Jo Trigg",
"type" : "user"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A list of Users and the roles they hold.
404
Object does not exist.
Up
post /orgs/{orgId}/apps/{appId}/users
Adds a User to an Application with a Role (orgsOrgIdAppsAppIdUsersPost)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The user ID and the role
example: {
"id" : "61048226-642c-438e-974f-ce5c013d94f8",
"role" : "manager"
}
Return type
Example data
Content-Type: application/json
{
"role" : "manager",
"user" : "61048226-642c-438e-974f-ce5c013d94f8",
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "730c1f96-8ee5-4bff-8c22-898e0530b924",
"invite" : "accepted",
"name" : "Jo Trigg",
"type" : "user"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The user ID and associated role.
UserRoleResponse
400
The request was invalid or the payload malformed.
HumanitecErrorResponse
404
The specified Application was not found.
422
The request body was not parseable.
Up
delete /orgs/{orgId}/apps/{appId}/users/{userId}
Remove the role of a User on an Application (orgsOrgIdAppsAppIdUsersUserIdDelete)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
userId (required)
Path Parameter — The User ID
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Role of the user successfully deleted.
400
The request was invalid or the payload malformed.
HumanitecErrorResponse
404
Object does not exist.
Up
get /orgs/{orgId}/apps/{appId}/users/{userId}
Get the role of a User on an Application (orgsOrgIdAppsAppIdUsersUserIdGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
userId (required)
Path Parameter — The User ID
Return type
Example data
Content-Type: application/json
{
"role" : "manager",
"user" : "61048226-642c-438e-974f-ce5c013d94f8",
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "730c1f96-8ee5-4bff-8c22-898e0530b924",
"invite" : "accepted",
"name" : "Jo Trigg",
"type" : "user"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The information on the user.
UserRoleResponse
400
The request was invalid or the payload malformed.
HumanitecErrorResponse
404
Object does not exist.
Up
patch /orgs/{orgId}/apps/{appId}/users/{userId}
Update the role of a User on an Application (orgsOrgIdAppsAppIdUsersUserIdPatch)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
userId (required)
Path Parameter — The User ID
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The new user role
Return type
Example data
Content-Type: application/json
{
"role" : "manager",
"user" : "61048226-642c-438e-974f-ce5c013d94f8",
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "730c1f96-8ee5-4bff-8c22-898e0530b924",
"invite" : "accepted",
"name" : "Jo Trigg",
"type" : "user"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The information on the user.
UserRoleResponse
400
The request was invalid or the payload malformed.
HumanitecErrorResponse
404
Object does not exist.
Up
post /orgs/{orgId}/env-types/{envType}/users
Adds a User to an Environment Type with a Role (orgsOrgIdEnvTypesEnvTypeUsersPost)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
envType (required)
Path Parameter — The Environment Type.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The user ID and the role
example: {
"id" : "61048226-642c-438e-974f-ce5c013d94f8",
"role" : "manager"
}
Return type
Example data
Content-Type: application/json
{
"role" : "manager",
"user" : "61048226-642c-438e-974f-ce5c013d94f8",
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "730c1f96-8ee5-4bff-8c22-898e0530b924",
"invite" : "accepted",
"name" : "Jo Trigg",
"type" : "user"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The user ID and associated role.
UserRoleResponse
400
The request was invalid or the payload malformed.
HumanitecErrorResponse
404
The specified Application was not found.
Up
delete /orgs/{orgId}/env-types/{envType}/users/{userId}
Remove the role of a User on an Environment Type (orgsOrgIdEnvTypesEnvTypeUsersUserIdDelete)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
envType (required)
Path Parameter — The Environment Type.
userId (required)
Path Parameter — The User ID
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Role of the user successfully deleted.
400
The request was invalid or the payload malformed.
HumanitecErrorResponse
404
Object does not exist.
Up
get /orgs/{orgId}/env-types/{envType}/users/{userId}
Get the role of a User on an Environment Type (orgsOrgIdEnvTypesEnvTypeUsersUserIdGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
envType (required)
Path Parameter — The Environment Type.
userId (required)
Path Parameter — The User ID
Return type
Example data
Content-Type: application/json
{
"role" : "manager",
"user" : "61048226-642c-438e-974f-ce5c013d94f8",
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "730c1f96-8ee5-4bff-8c22-898e0530b924",
"invite" : "accepted",
"name" : "Jo Trigg",
"type" : "user"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The information on the user.
UserRoleResponse
400
The request was invalid or the payload malformed.
HumanitecErrorResponse
404
Object does not exist.
Up
patch /orgs/{orgId}/env-types/{envType}/users/{userId}
Update the role of a User on an Environment Type (orgsOrgIdEnvTypesEnvTypeUsersUserIdPatch)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
envType (required)
Path Parameter — The Environment Type.
userId (required)
Path Parameter — The User ID
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The new user role
Return type
Example data
Content-Type: application/json
{
"role" : "manager",
"user" : "61048226-642c-438e-974f-ce5c013d94f8",
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "730c1f96-8ee5-4bff-8c22-898e0530b924",
"invite" : "accepted",
"name" : "Jo Trigg",
"type" : "user"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The information on the user.
UserRoleResponse
400
The request was invalid or the payload malformed.
HumanitecErrorResponse
404
Object does not exist.
Up
post /orgs/{orgId}/invitations
Invites a user to an Organization with a specified role. (orgsOrgIdInvitationsPost)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The email and the desired role
example: {
"email" : "jane.gonzales@example.com",
"role" : "manager"
}
Return type
Example data
Content-Type: application/json
[ {
"role" : "manager",
"user" : "61048226-642c-438e-974f-ce5c013d94f8",
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "730c1f96-8ee5-4bff-8c22-898e0530b924",
"invite" : "accepted",
"name" : "Jo Trigg",
"type" : "user"
}, {
"role" : "manager",
"user" : "61048226-642c-438e-974f-ce5c013d94f8",
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "730c1f96-8ee5-4bff-8c22-898e0530b924",
"invite" : "accepted",
"name" : "Jo Trigg",
"type" : "user"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
An temporary profile for the invited user.
400
The request was invalid or the payload malformed.
HumanitecErrorResponse
404
Object does not exist.
Up
get /orgs/{orgId}/users
List Users with roles in an Organization (orgsOrgIdUsersGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Return type
Example data
Content-Type: application/json
[ {
"role" : "manager",
"user" : "61048226-642c-438e-974f-ce5c013d94f8",
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "730c1f96-8ee5-4bff-8c22-898e0530b924",
"invite" : "accepted",
"name" : "Jo Trigg",
"type" : "user"
}, {
"role" : "manager",
"user" : "61048226-642c-438e-974f-ce5c013d94f8",
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "730c1f96-8ee5-4bff-8c22-898e0530b924",
"invite" : "accepted",
"name" : "Jo Trigg",
"type" : "user"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A list of Users and the roles they hold.
404
Object does not exist.
Up
delete /orgs/{orgId}/users/{userId}
Remove the role of a User on an Organization (orgsOrgIdUsersUserIdDelete)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
userId (required)
Path Parameter — The User ID
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Role of the user successfully deleted.
400
The request was invalid or the payload malformed.
HumanitecErrorResponse
404
Object does not exist.
Up
get /orgs/{orgId}/users/{userId}
Get the role of a User on an Organization (orgsOrgIdUsersUserIdGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
userId (required)
Path Parameter — The User ID
Return type
Example data
Content-Type: application/json
{
"role" : "manager",
"user" : "61048226-642c-438e-974f-ce5c013d94f8",
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "730c1f96-8ee5-4bff-8c22-898e0530b924",
"invite" : "accepted",
"name" : "Jo Trigg",
"type" : "user"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The information on the user.
UserRoleResponse
400
The request was invalid or the payload malformed.
HumanitecErrorResponse
404
Object does not exist.
Up
patch /orgs/{orgId}/users/{userId}
Update the role of a User on an Organization (orgsOrgIdUsersUserIdPatch)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
userId (required)
Path Parameter — The User ID
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — The new user the role
Return type
Example data
Content-Type: application/json
{
"role" : "manager",
"user" : "61048226-642c-438e-974f-ce5c013d94f8",
"created_at" : "2020-12-19T09:32:46Z",
"email" : "jo.trigg@awesomecorp.com",
"id" : "730c1f96-8ee5-4bff-8c22-898e0530b924",
"invite" : "accepted",
"name" : "Jo Trigg",
"type" : "user"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The information on the user.
UserRoleResponse
400
The request was invalid or the payload malformed.
HumanitecErrorResponse
404
Object does not exist.
Up
delete /orgs/{orgId}/apps/{appId}/envs/{envId}/values
Delete all Shared Value for an Environment (orgsOrgIdAppsAppIdEnvsEnvIdValuesDelete)
All Shared Values will be deleted. If the Shared Values are marked as a secret, they will also be deleted.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
Responses
204
Shared Value successfully deleted.
Up
get /orgs/{orgId}/apps/{appId}/envs/{envId}/values
List Shared Values in an Environment (orgsOrgIdAppsAppIdEnvsEnvIdValuesGet)
The returned values will be the base Application values with the Environment overrides where applicable. The source field will specify the level from which the value is from.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
Return type
Example data
Content-Type: application/json
[ {
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}, {
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty list of Values.
Up
delete /orgs/{orgId}/apps/{appId}/envs/{envId}/values/{key}
Delete Shared Value for an Environment (orgsOrgIdAppsAppIdEnvsEnvIdValuesKeyDelete)
The specified Shared Value will be permanently deleted. If the Shared Value is marked as a secret, it will also be permanently deleted.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
key (required)
Path Parameter — The key to update.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Shared Value successfully deleted.
400
Input not valid.
HumanitecErrorResponse
404
Shared Value does not exist.
HumanitecErrorResponse
Up
patch /orgs/{orgId}/apps/{appId}/envs/{envId}/values/{key}
Update Shared Value for an Environment (orgsOrgIdAppsAppIdEnvsEnvIdValuesKeyPatch)
Update the value or description of the Shared Value. Shared Values marked as secret can also be updated.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
key (required)
Path Parameter — The key to update.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — At least <code>value</code> or <code>description</code> must be supplied. All other fields will be ignored.
Return type
Example data
Content-Type: application/json
{
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Shared Value successfully updated.
ValueResponse
400
Input not valid.
HumanitecErrorResponse
404
Shared Value does not exist.
HumanitecErrorResponse
Up
put /orgs/{orgId}/apps/{appId}/envs/{envId}/values/{key}
Update Shared Value for an Environment (orgsOrgIdAppsAppIdEnvsEnvIdValuesKeyPut)
Update the value or description of the Shared Value. Shared Values marked as secret can also be updated.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
key (required)
Path Parameter — The key to update.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Both <code>value</code> and <code>description</code> must be supplied. All other fields will be ignored.
Return type
Example data
Content-Type: application/json
{
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Shared Value successfully updated.
ValueResponse
400
Input not valid.
HumanitecErrorResponse
404
Shared Value does not exist.
HumanitecErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/envs/{envId}/values
Create a Shared Value for an Environment (orgsOrgIdAppsAppIdEnvsEnvIdValuesPost)
The Shared Value created will only be available to the specific Environment.
If a Value is marked as a secret, it will be securely stored. It will not be possible to retrieve the value again through the API. The value of the secret can however be updated.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Definition of the new Shared Value.
Return type
Example data
Content-Type: application/json
{
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Shared Value successfully created.
ValueResponse
400
Input not valid.
HumanitecErrorResponse
409
Shared Value already exists.
HumanitecErrorResponse
Up
delete /orgs/{orgId}/apps/{appId}/values
Delete all Shared Value for an App (orgsOrgIdAppsAppIdValuesDelete)
All Shared Values will be deleted. If the Shared Values are marked as a secret, they will also be deleted.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Responses
204
Shared Values successfully deleted.
Up
get /orgs/{orgId}/apps/{appId}/values
List Shared Values in an Application (orgsOrgIdAppsAppIdValuesGet)
The returned values will be the "base" values for the Application. The overridden value for the Environment can be retrieved via the /orgs/{orgId}/apps/{appId}/envs/{envId}/values endpoint.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Return type
Example data
Content-Type: application/json
[ {
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}, {
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty list of Values.
Up
delete /orgs/{orgId}/apps/{appId}/values/{key}
Delete Shared Value for an Application (orgsOrgIdAppsAppIdValuesKeyDelete)
The specified Shared Value will be permanently deleted. If the Shared Value is marked as a secret, it will also be permanently deleted.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
key (required)
Path Parameter — The key to update.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
Shared Value successfully deleted.
400
Input not valid.
HumanitecErrorResponse
404
Shared Value does not exist.
HumanitecErrorResponse
Up
patch /orgs/{orgId}/apps/{appId}/values/{key}
Update Shared Value for an Application (orgsOrgIdAppsAppIdValuesKeyPatch)
Update the value or description of the Shared Value. Shared Values marked as secret can also be updated.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
key (required)
Path Parameter — The key to update.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — At least <code>value</code> or <code>description</code> must be supplied. All other fields will be ignored.
Return type
Example data
Content-Type: application/json
{
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Shared Value successfully updated.
ValueResponse
400
Input not valid.
HumanitecErrorResponse
404
Shared Value does not exist.
HumanitecErrorResponse
Up
put /orgs/{orgId}/apps/{appId}/values/{key}
Update Shared Value for an Application (orgsOrgIdAppsAppIdValuesKeyPut)
Update the value or description of the Shared Value. Shared Values marked as secret can also be updated.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
key (required)
Path Parameter — The key to update.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Both <code>value</code> and <code>description</code> must be supplied. All other fields will be ignored.
Return type
Example data
Content-Type: application/json
{
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
Shared Value successfully updated.
ValueResponse
400
Input not valid.
HumanitecErrorResponse
404
Shared Value does not exist.
HumanitecErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/values
Create a Shared Value for an Application (orgsOrgIdAppsAppIdValuesPost)
The Shared Value created will be available to all Environments in that Application.
If a Value is marked as a secret, it will be securely stored. It will not be possible to retrieve the value again through the API. The value of the secret can however be updated.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Definition of the new Shared Value.
Return type
Example data
Content-Type: application/json
{
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
Shared Value successfully created.
ValueResponse
400
Input not valid.
HumanitecErrorResponse
409
Shared Value already exists.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/envs/{envId}/value-set-versions
List Value Set Versions in an Environment of an App (orgsOrgIdAppsAppIdEnvsEnvIdValueSetVersionsGet)
A new Value Set Version is created on every modification of a Value inside the an Environment of an App. In case this environment has no overrides the response is the same as the App level endpoint.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
Query parameters
key_changed (optional)
Query Parameter — (Optional) Return only value set version where the specified key changed
Return type
Example data
Content-Type: application/json
[ {
"result_of" : "app_value_create",
"updated_at" : "2020-06-22T09:37:23.523Z",
"change" : [ {
"op" : "op",
"path" : "path",
"value" : ""
}, {
"op" : "op",
"path" : "path",
"value" : ""
} ],
"source_value_set_version_id" : "source_value_set_version_id",
"values" : {
"key" : {
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}
},
"created_at" : "2020-06-22T09:37:23.523Z",
"comment" : "comment",
"id" : "id",
"created_by" : "created_by"
}, {
"result_of" : "app_value_create",
"updated_at" : "2020-06-22T09:37:23.523Z",
"change" : [ {
"op" : "op",
"path" : "path",
"value" : ""
}, {
"op" : "op",
"path" : "path",
"value" : ""
} ],
"source_value_set_version_id" : "source_value_set_version_id",
"values" : {
"key" : {
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}
},
"created_at" : "2020-06-22T09:37:23.523Z",
"comment" : "comment",
"id" : "id",
"created_by" : "created_by"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty list of ValueSetVersion.
Up
get /orgs/{orgId}/apps/{appId}/envs/{envId}/value-set-versions/{valueSetVersionId}
Get a single Value Set Version in an Environment of an App (orgsOrgIdAppsAppIdEnvsEnvIdValueSetVersionsValueSetVersionIdGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
valueSetVersionId (required)
Path Parameter — The ValueSetVersion ID. format: uuid
Return type
Example data
Content-Type: application/json
{
"result_of" : "app_value_create",
"updated_at" : "2020-06-22T09:37:23.523Z",
"change" : [ {
"op" : "op",
"path" : "path",
"value" : ""
}, {
"op" : "op",
"path" : "path",
"value" : ""
} ],
"source_value_set_version_id" : "source_value_set_version_id",
"values" : {
"key" : {
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}
},
"created_at" : "2020-06-22T09:37:23.523Z",
"comment" : "comment",
"id" : "id",
"created_by" : "created_by"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The requested ValueSetVersion
ValueSetVersionResponse
404
ValueSetVersion with <code>valueSetVersionId</code> in Environment.
HumanitecErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/envs/{envId}/value-set-versions/{valueSetVersionId}/purge/{key}
Purge the value of a specific Shared Value from the App Environment Version history. (orgsOrgIdAppsAppIdEnvsEnvIdValueSetVersionsValueSetVersionIdPurgeKeyPost)
Purging permanently removes the value of a specific Shared Value in an application. A purged value is no longer accessible, can't be restored and can't be used
by deployments referencing a Value Set Version where the value was present.
Learn more about purging in our docs.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
valueSetVersionId (required)
Path Parameter — The ValueSetVersion ID. format: uuid
key (required)
Path Parameter — Key of the value to be purged.
Consumes
This API call consumes the following media types via the request header:
Request body
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
key successfully purged
400
The specified key can't be purged in this version.
HumanitecErrorResponse
404
No ValueSetVersion with <code>valueSetVersionId</code> in App Environment.
HumanitecErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/envs/{envId}/value-set-versions/{valueSetVersionId}/restore/{key}
Restore a specific key from the Value Set Version in an Environment of an App (orgsOrgIdAppsAppIdEnvsEnvIdValueSetVersionsValueSetVersionIdRestoreKeyPost)
Restore the values of a single Shared Value in an Environment from a specific version.
Learn more about reverting in our docs.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
valueSetVersionId (required)
Path Parameter — The ValueSetVersion ID. format: uuid
key (required)
Path Parameter — Key of the value to be restored.
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result_of" : "app_value_create",
"updated_at" : "2020-06-22T09:37:23.523Z",
"change" : [ {
"op" : "op",
"path" : "path",
"value" : ""
}, {
"op" : "op",
"path" : "path",
"value" : ""
} ],
"source_value_set_version_id" : "source_value_set_version_id",
"values" : {
"key" : {
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}
},
"created_at" : "2020-06-22T09:37:23.523Z",
"comment" : "comment",
"id" : "id",
"created_by" : "created_by"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The resulting ValueSetVersion
ValueSetVersionResponse
400
Invalid request
HumanitecErrorResponse
404
No ValueSetVersion with <code>valueSetVersionId</code> in App Environment.
HumanitecErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/envs/{envId}/value-set-versions/{valueSetVersionId}/restore
Restore a Value Set Version in an Environment of an App (orgsOrgIdAppsAppIdEnvsEnvIdValueSetVersionsValueSetVersionIdRestorePost)
Restore the values of all Shared Values in an environment from a specific version. Keys not existing in the selected version are deleted.
Learn more about reverting in our docs.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
envId (required)
Path Parameter — The Environment ID.
valueSetVersionId (required)
Path Parameter — The ValueSetVersion ID. format: uuid
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result_of" : "app_value_create",
"updated_at" : "2020-06-22T09:37:23.523Z",
"change" : [ {
"op" : "op",
"path" : "path",
"value" : ""
}, {
"op" : "op",
"path" : "path",
"value" : ""
} ],
"source_value_set_version_id" : "source_value_set_version_id",
"values" : {
"key" : {
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}
},
"created_at" : "2020-06-22T09:37:23.523Z",
"comment" : "comment",
"id" : "id",
"created_by" : "created_by"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The resulting ValueSetVersion
ValueSetVersionResponse
404
No ValueSetVersion with <code>valueSetVersionId</code> in App Environment.
HumanitecErrorResponse
Up
get /orgs/{orgId}/apps/{appId}/value-set-versions
List Value Set Versions in the App (orgsOrgIdAppsAppIdValueSetVersionsGet)
A new Value Set Version is created on every modification of a Value inside the app.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
Query parameters
key_changed (optional)
Query Parameter — (Optional) Return only value set version where the specified key changed
Return type
Example data
Content-Type: application/json
[ {
"result_of" : "app_value_create",
"updated_at" : "2020-06-22T09:37:23.523Z",
"change" : [ {
"op" : "op",
"path" : "path",
"value" : ""
}, {
"op" : "op",
"path" : "path",
"value" : ""
} ],
"source_value_set_version_id" : "source_value_set_version_id",
"values" : {
"key" : {
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}
},
"created_at" : "2020-06-22T09:37:23.523Z",
"comment" : "comment",
"id" : "id",
"created_by" : "created_by"
}, {
"result_of" : "app_value_create",
"updated_at" : "2020-06-22T09:37:23.523Z",
"change" : [ {
"op" : "op",
"path" : "path",
"value" : ""
}, {
"op" : "op",
"path" : "path",
"value" : ""
} ],
"source_value_set_version_id" : "source_value_set_version_id",
"values" : {
"key" : {
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}
},
"created_at" : "2020-06-22T09:37:23.523Z",
"comment" : "comment",
"id" : "id",
"created_by" : "created_by"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty list of ValueSetVersion.
Up
get /orgs/{orgId}/apps/{appId}/value-set-versions/{valueSetVersionId}
Get a single Value Set Version from the App (orgsOrgIdAppsAppIdValueSetVersionsValueSetVersionIdGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
valueSetVersionId (required)
Path Parameter — The ValueSetVersion ID. format: uuid
Return type
Example data
Content-Type: application/json
{
"result_of" : "app_value_create",
"updated_at" : "2020-06-22T09:37:23.523Z",
"change" : [ {
"op" : "op",
"path" : "path",
"value" : ""
}, {
"op" : "op",
"path" : "path",
"value" : ""
} ],
"source_value_set_version_id" : "source_value_set_version_id",
"values" : {
"key" : {
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}
},
"created_at" : "2020-06-22T09:37:23.523Z",
"comment" : "comment",
"id" : "id",
"created_by" : "created_by"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The requested ValueSetVersion
ValueSetVersionResponse
404
ValueSetVersion with <code>valueSetVersionId</code> in App.
HumanitecErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/value-set-versions/{valueSetVersionId}/purge/{key}
Purge the value of a specific Shared Value from the App Version history. (orgsOrgIdAppsAppIdValueSetVersionsValueSetVersionIdPurgeKeyPost)
Purging permanently removes the value of a specific Shared Value in an Application. A purged value is no longer accessible, can't be restored and can't be used
by deployments referencing a Value Set Version where the value was present.
Learn more about purging in our docs.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
valueSetVersionId (required)
Path Parameter — The ValueSetVersion ID. format: uuid
key (required)
Path Parameter — Key of the value to be purged.
Consumes
This API call consumes the following media types via the request header:
Request body
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
key successfully purged
400
The specified key can't be purged in this version.
HumanitecErrorResponse
404
No ValueSetVersion with <code>valueSetVersionId</code> in App.
HumanitecErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/value-set-versions/{valueSetVersionId}/restore/{key}
Restore a specific key from the Value Set Version in an App (orgsOrgIdAppsAppIdValueSetVersionsValueSetVersionIdRestoreKeyPost)
Restore the values of a single Shared Value in an application from a specific version.
Learn more about reverting in our docs.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
valueSetVersionId (required)
Path Parameter — The ValueSetVersion ID. format: uuid
key (required)
Path Parameter — Key of the value to be restored.
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result_of" : "app_value_create",
"updated_at" : "2020-06-22T09:37:23.523Z",
"change" : [ {
"op" : "op",
"path" : "path",
"value" : ""
}, {
"op" : "op",
"path" : "path",
"value" : ""
} ],
"source_value_set_version_id" : "source_value_set_version_id",
"values" : {
"key" : {
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}
},
"created_at" : "2020-06-22T09:37:23.523Z",
"comment" : "comment",
"id" : "id",
"created_by" : "created_by"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The resulting ValueSetVersion
ValueSetVersionResponse
400
Invalid request
HumanitecErrorResponse
404
No ValueSetVersion with <code>valueSetVersionId</code> in App.
HumanitecErrorResponse
Up
post /orgs/{orgId}/apps/{appId}/value-set-versions/{valueSetVersionId}/restore
Restore a Value Set Version in an App (orgsOrgIdAppsAppIdValueSetVersionsValueSetVersionIdRestorePost)
Restore the values of all Shared Values in an application from a specific version. Keys not existing in the selected version are deleted.
Learn more about reverting in our docs.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
appId (required)
Path Parameter — The Application ID.
valueSetVersionId (required)
Path Parameter — The ValueSetVersion ID. format: uuid
Consumes
This API call consumes the following media types via the request header:
Request body
Return type
Example data
Content-Type: application/json
{
"result_of" : "app_value_create",
"updated_at" : "2020-06-22T09:37:23.523Z",
"change" : [ {
"op" : "op",
"path" : "path",
"value" : ""
}, {
"op" : "op",
"path" : "path",
"value" : ""
} ],
"source_value_set_version_id" : "source_value_set_version_id",
"values" : {
"key" : {
"description" : "The message to show me.",
"is_secret" : false,
"key" : "MY_MSG",
"value" : "Hello World"
}
},
"created_at" : "2020-06-22T09:37:23.523Z",
"comment" : "comment",
"id" : "id",
"created_by" : "created_by"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The resulting ValueSetVersion
ValueSetVersionResponse
404
No ValueSetVersion with <code>valueSetVersionId</code> in App.
HumanitecErrorResponse
Up
post /orgs/{orgId}/workload-profile-chart-versions
Add new Workload Profile Chart Version (createWorkloadProfileChartVersion)
Creates a Workload Profile Chart Version from the uploaded Helm chart. The name and version is retrieved from the chart's metadata (Charts.yaml file).
The request has content type multipart/form-data and the request body includes one part:
file with application/x-gzip content type which is an archive containing a Helm chart.
Request body example:
Content-Type: multipart/form-data; boundary=----boundary ----boundary Content-Disposition: form-data; name="file"; filename="my-workload-1.0.1.tgz" Content-Type: application/x-gzip [TGZ_DATA] ----boundary
Path parameters
orgId (required)
Path Parameter — The Organization ID
Consumes
This API call consumes the following media types via the request header:
Form parameters
file (required)
Form Parameter — format: binary
Return type
Example data
Content-Type: application/json
{
"org_id" : "org_id",
"created_at" : "2020-06-22T09:37:23.523Z",
"id" : "id",
"created_by" : "created_by",
"version" : "version"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
The newly created Workload Profile Chart Version metadata.
WorkloadProfileChartVersionResponse
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
409
The request itself is valid however it could not be applied based on the current state of the resource.
More detail can be found in the error body.
HumanitecErrorResponse
Up
post /orgs/{orgId}/workload-profiles/{profileQid}/versions
Add new Version of the Workload Profile (createWorkloadProfileVersion)
Creates a Workload Profile Version for the given Workload Profile.
Path parameters
orgId (required)
Path Parameter — The Organization ID
profileQid (required)
Path Parameter — The Workload Profile ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Workload profile version metadata.
Return type
Example data
Content-Type: application/json
{
"workload_profile_chart" : {
"id" : "id",
"version" : "version"
},
"features" : "",
"spec_definition" : {
"runtime_properties" : [ null, null ],
"properties" : {
"key" : {
"schema" : "",
"feature_name" : "feature_name",
"type" : "feature",
"title" : "title",
"runtime_properties" : [ {
"feature_name" : "feature_name",
"type" : "feature",
"title" : "title",
"version" : "version"
}, {
"feature_name" : "feature_name",
"type" : "feature",
"title" : "title",
"version" : "version"
} ],
"version" : "version",
"ui_hints" : {
"hidden" : true,
"order" : 0
}
}
}
},
"notes" : "notes",
"spec_schema" : "",
"org_id" : "org_id",
"profile_id" : "profile_id",
"created_at" : "2020-06-22T09:37:23.523Z",
"created_by" : "created_by",
"version" : "version"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
The newly created Workload Profile Version metadata.
WorkloadProfileVersionResponse
400
The request was invalid. More detail can be found in the error body.
HumanitecErrorResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
409
The request itself is valid however it could not be applied based on the current state of the resource.
More detail can be found in the error body.
HumanitecErrorResponse
Up
get /orgs/{orgId}/workload-profiles/{profileQid}/versions/latest
Latest version of the given workload profile with optional constraint. (getLatestWorkloadProfileVersion)
Path parameters
orgId (required)
Path Parameter — The Organization ID
profileQid (required)
Path Parameter — The Workload Profile ID.
Return type
Example data
Content-Type: application/json
{
"workload_profile_chart" : {
"id" : "id",
"version" : "version"
},
"features" : "",
"spec_definition" : {
"runtime_properties" : [ null, null ],
"properties" : {
"key" : {
"schema" : "",
"feature_name" : "feature_name",
"type" : "feature",
"title" : "title",
"runtime_properties" : [ {
"feature_name" : "feature_name",
"type" : "feature",
"title" : "title",
"version" : "version"
}, {
"feature_name" : "feature_name",
"type" : "feature",
"title" : "title",
"version" : "version"
} ],
"version" : "version",
"ui_hints" : {
"hidden" : true,
"order" : 0
}
}
}
},
"notes" : "notes",
"spec_schema" : "",
"org_id" : "org_id",
"profile_id" : "profile_id",
"created_at" : "2020-06-22T09:37:23.523Z",
"created_by" : "created_by",
"version" : "version"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
A possibly empty list of Workload Profile Versions.
WorkloadProfileVersionResponse
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
Up
get /orgs/{orgId}/workload-profile-chart-versions
Workload Profile Chart Versions for the given organization. (listWorkloadProfileChartVersions)
Returns all Workload Profile Chart Versions for the given organization.
Path parameters
orgId (required)
Path Parameter — The Organization ID
Query parameters
per_page (optional)
Query Parameter — The maximum number of items to return in a page of results default: 50
page (optional)
Query Parameter — The page token to request from
Return type
Example data
Content-Type: application/json
[ {
"org_id" : "org_id",
"created_at" : "2020-06-22T09:37:23.523Z",
"id" : "id",
"created_by" : "created_by",
"version" : "version"
}, {
"org_id" : "org_id",
"created_at" : "2020-06-22T09:37:23.523Z",
"id" : "id",
"created_by" : "created_by",
"version" : "version"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
List of Workload Profile Chart Versions.
Up
get /orgs/{orgId}/workload-profiles/{profileQid}/versions
List versions of the given workload profile. (listWorkloadProfileVersions)
Path parameters
orgId (required)
Path Parameter — The Organization ID
profileQid (required)
Path Parameter — The Workload Profile ID.
Query parameters
per_page (optional)
Query Parameter — The maximum number of items to return in a page of results default: 50
page (optional)
Query Parameter — The page token to request from
Return type
Example data
Content-Type: application/json
[ {
"workload_profile_chart" : {
"id" : "id",
"version" : "version"
},
"features" : "",
"spec_definition" : {
"runtime_properties" : [ null, null ],
"properties" : {
"key" : {
"schema" : "",
"feature_name" : "feature_name",
"type" : "feature",
"title" : "title",
"runtime_properties" : [ {
"feature_name" : "feature_name",
"type" : "feature",
"title" : "title",
"version" : "version"
}, {
"feature_name" : "feature_name",
"type" : "feature",
"title" : "title",
"version" : "version"
} ],
"version" : "version",
"ui_hints" : {
"hidden" : true,
"order" : 0
}
}
}
},
"notes" : "notes",
"spec_schema" : "",
"org_id" : "org_id",
"profile_id" : "profile_id",
"created_at" : "2020-06-22T09:37:23.523Z",
"created_by" : "created_by",
"version" : "version"
}, {
"workload_profile_chart" : {
"id" : "id",
"version" : "version"
},
"features" : "",
"spec_definition" : {
"runtime_properties" : [ null, null ],
"properties" : {
"key" : {
"schema" : "",
"feature_name" : "feature_name",
"type" : "feature",
"title" : "title",
"runtime_properties" : [ {
"feature_name" : "feature_name",
"type" : "feature",
"title" : "title",
"version" : "version"
}, {
"feature_name" : "feature_name",
"type" : "feature",
"title" : "title",
"version" : "version"
} ],
"version" : "version",
"ui_hints" : {
"hidden" : true,
"order" : 0
}
}
}
},
"notes" : "notes",
"spec_schema" : "",
"org_id" : "org_id",
"profile_id" : "profile_id",
"created_at" : "2020-06-22T09:37:23.523Z",
"created_by" : "created_by",
"version" : "version"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
List of Workload Profile Versions.
404
Either the resource or a related resource could not be found. More detail can be found in the error body.
HumanitecErrorResponse
Up
get /orgs/{orgId}/workload-profiles
List workload profiles available to the organization. (orgsOrgIdWorkloadProfilesGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID
Query parameters
per_page (optional)
Query Parameter — The maximum number of items to return in a page of results default: 50
page (optional)
Query Parameter — The page token to request from
Return type
Example data
Content-Type: application/json
[ {
"org_id" : "org_id",
"created_at" : "2020-06-22T09:37:23.523Z",
"id" : "id",
"created_by" : "created_by",
"latest" : "latest"
}, {
"org_id" : "org_id",
"created_at" : "2020-06-22T09:37:23.523Z",
"id" : "id",
"created_by" : "created_by",
"latest" : "latest"
} ]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
List of Workload Profiles.
Up
post /orgs/{orgId}/workload-profiles
Create new Workload Profile (orgsOrgIdWorkloadProfilesPost)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
Consumes
This API call consumes the following media types via the request header:
Request body
Body Parameter — Workload profile details.
Return type
Example data
Content-Type: application/json
{
"org_id" : "org_id",
"created_at" : "2020-06-22T09:37:23.523Z",
"id" : "id",
"created_by" : "created_by",
"latest" : "latest"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
201
The newly created Workload Profile.
WorkloadProfileResponse
400
One or more request parameters is missing or invalid.
HumanitecErrorResponse
409
A Workload Profile already exists.
HumanitecErrorResponse
Up
delete /orgs/{orgId}/workload-profiles/{profileId}/versions/{version}
Delete a Workload Profile Version (orgsOrgIdWorkloadProfilesProfileIdVersionsVersionDelete)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
profileId (required)
Path Parameter — The Workload profile ID.
version (required)
Path Parameter — The Version.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
The Workload Profile Version has been marked for deletion.
404
The Workload Profile Version is not found or is not accessible by the organization.
HumanitecErrorResponse
Up
delete /orgs/{orgId}/workload-profiles/{profileQid}
Delete a Workload Profile (orgsOrgIdWorkloadProfilesProfileQidDelete)
This will also delete all versions of a workload profile.
It is not possible to delete profiles of other organizations.
Path parameters
orgId (required)
Path Parameter — The Organization ID.
profileQid (required)
Path Parameter — The Workload profile ID.
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
204
The Workload Profile has been marked for deletion.
404
The Workload Profile is not found or is not accessible by the organization.
HumanitecErrorResponse
Up
get /orgs/{orgId}/workload-profiles/{profileQid}
Get a Workload Profile (orgsOrgIdWorkloadProfilesProfileQidGet)
Path parameters
orgId (required)
Path Parameter — The Organization ID.
profileQid (required)
Path Parameter — The fully qualified Workload ID. (If not a profile from the current org, must be prefixed with <code>{orgId}.</code> e.g. <code>humanitec.default-cronjob</code>)
Return type
Example data
Content-Type: application/json
{
"org_id" : "org_id",
"created_at" : "2020-06-22T09:37:23.523Z",
"id" : "id",
"created_by" : "created_by",
"latest" : "latest"
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the response header.
Responses
200
The requested WorkloadProfile.
WorkloadProfileResponse
404
The requested WorkloadProfile is not found.
HumanitecErrorResponse
[ Jump to Methods ]
Table of Contents
AWSAuthRequestAWSSMRequestAWSSMResponseAccountCredsRequestAccountTypeRequestAccountTypeResponseActiveResourceRequestActiveResourceResponseAddArtefactVersionPayloadRequestApplicationCreationRequestApplicationRequestApplicationResponseApprovalRequestArtefactRequestArtefactResponseArtefactVersionRequestArtefactVersionResponseAutomationRuleRequestAutomationRuleResponseAzureAuthRequestAzureKVRequestAzureKVResponseClusterSecretRequestClusterSecretResponseClusterSecretsMapRequestClusterSecretsMapResponseControllerRequestControllerResponseCreateDriverRequestRequestCreateResourceAccountRequestRequestCreateResourceDefinitionRequestRequestCreateSecretStorePayloadRequestDeltaMetadataRequestDeltaMetadataResponseDeltaRequestDeltaResponseDeployConditionRequestDeployConditionResponseDeploymentErrorRequestDeploymentErrorResponseDeploymentRequestDeploymentResponseDriverDefinitionRequestDriverDefinitionResponseEnvironmentBaseRequestEnvironmentBaseResponseEnvironmentDefinitionRequestEnvironmentRequestEnvironmentResponseEnvironmentRuntimeInfoResponseEnvironmentTypeRequestEnvironmentTypeResponseErrorInfoResponseErrorResponseEventBaseRequestEventBaseResponseEventResponseGCPAuthRequestGCPSMRequestGCPSMResponseHumanitecErrorResponseHumanitecPublicKeyHumanitecRequestHumanitecResponseImageBuildRequestImageBuildResponseImageRequestImageResponseImagesRegistryCredsRequestImagesRegistryCredsResponseJSONFieldRequestJSONFieldResponseJSONPatchRequestJSONPatchResponseJSONPatchesResponseLogoResponseManifestRequestManifestResponseMatchingCriteriaRequestMatchingCriteriaResponseMatchingCriteriaRuleRequestModuleDeltasRequestModuleDeltasResponseModuleRequestModuleResponseNewServiceUserRequestNodeBodyResponseOrganizationRequestOrganizationResponsePatchResourceDefinitionRequestRequestPipelinePipelineVersionPlainDeltaResponsePodStateRequestPodStateResponseProvisionDependenciesRequestProvisionDependenciesResponsePublicKeyRegistryCredsResponseRegistryRequestRegistryResponseResourceAccountRequestResourceAccountResponseResourceDefinitionChangeResponseResourceDefinitionRequestResourceDefinitionResponseResourceProvisionRequestRequestResourceTypeRequestResourceTypeResponseRoleRequestRunCreateRequestRunJobListResponseRunJobResponseRunJobStepRunJobStepLogRunResponseRuntimeInfoRequestRuntimeInfoResponseSecretReferenceSecretStoreRequestSecretStoreResponseSetRequestSetResponseTokenDefinitionRequestTokenInfoRequestTokenInfoResponseTokenResponseUpdateActionRequestUpdateActionResponseUpdateArtefactVersionPayloadRequestUpdateDriverRequestRequestUpdateResourceAccountRequestRequestUpdateResourceDefinitionRequestRequestUpdateSecretStorePayloadRequestUserInviteRequestRequestUserInviteResponseUserProfileExtendedRequestUserProfileExtendedResponseUserProfileRequestUserProfileResponseUserRoleRequestUserRoleResponseValueCreatePayloadRequestValueEditPayloadRequestValuePatchPayloadRequestValueRequestValueResponseValueSetActionPayloadRequestValueSetResponseValueSetVersionResponseValueSetVersionResultOfValueSourceValuesSecretsRefsRequestValuesSecretsRefsResponseVaultAuthRequestVaultRequestVaultResponseWebhookRequestWebhookResponseWebhookUpdateResponseWorkloadProfileChartReferenceWorkloadProfileChartVersionResponseWorkloadProfileRequestWorkloadProfileResponseWorkloadProfileVersionRequestWorkloadProfileVersionResponseWorkloadProfileVersionSpecDefinitionWorkloadProfileVersionSpecDefinitionPropertiesWorkloadProfileVersionSpecDefinitionPropertyWorkloadProfileVersionSpecDefinitionPropertyTypeWorkloadProfileVersionSpecDefinitionPropertyUIHintsWorkloadProfileVersionSpecDefinitionRuntimePropertyWorkloadProfileVersionSpecDefinitionRuntimePropertyTypeinline_response_200inline_response_200_1orgId_workloadprofilechartversions_body
Credentials to authenticate AWS Secret Manager.
access_key_id (optional)
secret_access_key (optional)
AWS Secret Manager specification.
auth (optional)
endpoint (optional)
region (optional)
AWS Secret Manager specification.
endpoint (optional)
region (optional)
AccountCreds represents an account credentials (either, username- or token-based).
expires (optional)
String Account credentials expiration timestamp.
example: 2020-06-22T09:37:23.523Z
password
String Account password or token secret.
username
String Security account login or token.
Resource Account Types define cloud providers or protocols to which a resource account can belong.
name (optional)
type (optional)
String Unique account type identifier (system-wide, across all organizations).
Resource Account Types define cloud providers or protocols to which a resource account can belong.
name
type
String Unique account type identifier (system-wide, across all organizations).
<p>Active Resources represent the concrete resources provisioned for an Environment. They are provisioned on the first deployment after a dependency on a particular resource type is introduced into an Environment. In general, Active Resources are only deleted when their introductory Environment is deleted.</p>
<p>Active Resources are provisioned based on a Resource Definition. The Resource Definition describes how to provision a concrete resource based on a Resource Type and metadata about the Environment (for example the Environment Type or the Application ID). The criteria for how to choose a Resource Definition is known as a Matching Criteria. If the Matching Criteria changes or the Resource Definition is deleted, the concrete resource represented by an Active Resource might be deleted and reprovisioned when a deployment occurs in the Environment.</p>
app_id (optional)
String The ID of the App the resource is associated with.
class (optional)
String The Resource Class of the resource
criteria_id (optional)
String The Matching Criteria ID.
def_id (optional)
String The Resource Definition that this resource was provisioned from.
deploy_id (optional)
String The deployment that the resource was last provisioned in.
driver_type (optional)
String The driver to be used to create the resource.
env_id (optional)
String The ID of the Environment the resource is associated with.
env_type (optional)
String The Environment Type of the Environment specified by env_id.
gu_res_id (optional)
String Globally unique resource id
org_id (optional)
String the ID of the Organization the Active Resource is associated with.
res_id (optional)
resource (optional)
status (optional)
String Current resource status: 'pending', 'active', or 'deleting'.
type (optional)
String The Resource Type of the resource
updated_at (optional)
String The time the resource was last provisioned as part of a deployment.
example: 2020-06-22T09:37:23.523Z
<p>Active Resources represent the concrete resources provisioned for an Environment. They are provisioned on the first deployment after a dependency on a particular resource type is introduced into an Environment. In general, Active Resources are only deleted when their introductory Environment is deleted.</p>
<p>Active Resources are provisioned based on a Resource Definition. The Resource Definition describes how to provision a concrete resource based on a Resource Type and metadata about the Environment (for example the Environment Type or the Application ID). The criteria for how to choose a Resource Definition is known as a Matching Criteria. If the Matching Criteria changes or the Resource Definition is deleted, the concrete resource represented by an Active Resource might be deleted and reprovisioned when a deployment occurs in the Environment.</p>
app_id
String The ID of the App the resource is associated with.
class
String The Resource Class of the resource
criteria_id (optional)
String The Matching Criteria ID.
def_id
String The Resource Definition that this resource was provisioned from.
deploy_id
String The deployment that the resource was last provisioned in.
driver_type (optional)
String The driver to be used to create the resource.
env_id
String The ID of the Environment the resource is associated with.
env_type
String The Environment Type of the Environment specified by env_id.
gu_res_id
String Globally unique resource id
org_id
String the ID of the Organization the Active Resource is associated with.
res_id
resource
status
String Current resource status: 'pending', 'active', or 'deleting'.
type
String The Resource Type of the resource
updated_at
String The time the resource was last provisioned as part of a deployment.
example: 2020-06-22T09:37:23.523Z
AddArtefactVersionPayload describes the payload for a new ArtefactVersion request.
commit (optional)
String (Optional) The commit ID the Artefact Version was built on.
digest (optional)
String (Optional) The Artefact Version digest.
name
ref (optional)
String (Optional) The ref the Artefact Version was built from.
type
String The Artefact Version type.
version (optional)
String (Optional) The Artefact Version.
env (optional)
id
String The ID which refers to a specific application.
name
String The Human-friendly name for the Application.
<p>An Application is a collection of Workloads that work together. When deployed, all Workloads in an Application are deployed to the same namespace.</p>
<p>Apps are the root of the configuration tree holding Environments, Deployments, Shared Values, and Secrets.</p>
id
String The ID which refers to a specific application.
name
String The Human-friendly name for the Application.
<p>An Application is a collection of Workloads that work together. When deployed, all Workloads in an Application are deployed to the same namespace.</p>
<p>Apps are the root of the configuration tree holding Environments, Deployments, Shared Values, and Secrets.</p>
created_at
String The timestamp in UTC indicates when the Application was created.
example: 2020-06-22T09:37:23.523Z
created_by
String The user who created the Application.
envs
id
String The ID which refers to a specific application.
name
String The Human-friendly name for the Application.
org_id
String The Organization id of this Application
An approval object
id (optional)
String The id of the approval object.
org_id (optional)
String The id of the Organization.
example: sample-org
app_id (optional)
String The id of the Application.
example: sample-app
pipeline_id (optional)
String The id of the Pipeline.
example: sample-pipeline
run_id (optional)
String The id of the Pipeline's Run.
example: 01234567-89ab-cdef-0123-456789abcdef
job_id (optional)
String The id of the Run's Job.
example: deploy
env_id (optional)
String The environment for which the approver needs to have deploy permission to approve the job.
example: production
message (optional)
String A human-readable message indicating the reason for approval.
example: Promoting app to production
created_at (optional)
Date The date and time when the approval request was created. format: date-time
example: 2023-01-01T00:00Z
status (optional)
String The current status of the approval request.
waiting
approved
denied
cancelled
example: waiting
approved_by (optional)
String The user who approved or denied the request.
example: 0123456789ab-cdef-0123-456789abcdef
approved_at (optional)
Date The date and time when the request was approved or denied. format: date-time
example: 2023-01-01T00:00Z
Artefacts can be registered with Humanitec. Continuous Integration (CI) pipelines notify Humanitec when a new version of an Artefact becomes available. Humanitec tracks the Artefact along with metadata about how it was built.
id
String The UUID of the Artefact.
name
String The name of the Artefact.
type
String The type of the Artefact.
Artefacts can be registered with Humanitec. Continuous Integration (CI) pipelines notify Humanitec when a new version of an Artefact becomes available. Humanitec tracks the Artefact along with metadata about how it was built.
created_at (optional)
String The time when the Artefact was added to Humanitec.
example: 2020-06-22T09:37:23.523Z
created_by (optional)
String The user ID of the user who added the Artefact to Humanitec.
id
String The UUID of the Artefact.
name
String The name of the Artefact.
type
String The type of the Artefact.
updated_at (optional)
String The time when the Artefact was updated for the last time.
example: 2020-06-22T09:37:23.523Z
updated_by (optional)
String The user ID of the user who updated the Artefact for the last time.
An Artefact Version represents a particular version of an Artefact that can be added to an Application.
archived (optional)
Boolean If the Artefact Version is archived.
artefact_id
String The UUID of the Artefact.
commit (optional)
String (Optional) The commit ID the Artefact Version was built on.
digest (optional)
String (Optional) The Artefact Version digest.
id
String The UUID of the Artefact Version.
name
String The name of the Artefact.
ref (optional)
String (Optional) The ref the Artefact Version was built from.
version (optional)
String (Optional) The version of the Artefact Version.
An Artefact Version represents a particular version of an Artefact that can be added to an Application.
archived
Boolean If the Artefact Version is archived.
artefact_id
String The UUID of the Artefact.
commit
String (Optional) The commit ID the Artefact Version was built on.
created_at (optional)
String The time when the Artefact Version was added to Humanitec.
example: 2020-06-22T09:37:23.523Z
created_by (optional)
String The user ID of the user who added the Artefact Version to Humanitec.
digest
String (Optional) The Artefact Version digest.
id
String The UUID of the Artefact Version.
name
String The name of the Artefact.
ref
String (Optional) The ref the Artefact Version was built from.
updated_at (optional)
String The time when the Artefact Version was updated for the last time.
example: 2020-06-22T09:37:23.523Z
updated_by (optional)
String The user ID of the user who performed the last updated on the Artefact Version.
version
String (Optional) The version of the Artefact Version.
An Automation Rule defining how and when artefacts in an environment should be updated.
active (optional)
Boolean Whether the rule will be processed or not.
artefacts_filter (optional)
array[String] A list of artefact names to be processed by the rule. If the array is empty, it implies include all. If <code>exclude_artefacts_filter</code> is true, this list describes the artefacts to exclude.
exclude_artefacts_filter (optional)
Boolean Whether the artefacts specified in <code>artefacts_filter</code> should be excluded (true) or included (false) in the automation rule.
exclude_images_filter (optional)
Boolean DEPRECATED: Whether the images specified in <code>images_filter</code> should be excluded (true) or included (false) in the automation rule.
images_filter (optional)
array[String] DEPRECATED: A list of image IDs to be processed by the rule. If the array is empty, it implies include all. If <code>exclude_images_filter</code> is true, this list describes images to exclude.
match (optional)
String DEPRECATED: A regular expression applied to the branch or tag name depending on the value of <code>update_to</code>. Defaults to match all if omitted or empty.
match_ref (optional)
String A regular expression applied to the ref of a new artefact version. Defaults to match all if omitted or empty.
type
String Specifies the type of event. Currently, only updates to either branches or tags are supported. Must be <code>"update"</code>.
update_to (optional)
String DEPRECATED: Specifies whether the update occurs on commit to branch or creation of tag. Must be one of <code>"branch"</code> or <code>"tag"</code>.
An Automation Rule defining how and when artefacts in an environment should be updated.
active
Boolean Whether the rule will be processed or not.
artefacts_filter
array[String] A list of artefact names to be processed by the rule. If the array is empty, it implies include all. If <code>exclude_artefacts_filter</code> is true, this list describes the artefacts to exclude.
created_at
String The timestamp in UTC of when the Automation Rule was created.
example: 2020-06-22T09:37:23.523Z
exclude_artefacts_filter
Boolean Whether the artefacts specified in <code>artefacts_filter</code> should be excluded (true) or included (false) in the automation rule.
exclude_images_filter
Boolean DEPRECATED: Whether the images specified in <code>images_filter</code> should be excluded (true) or included (false) in the automation rule.
id
String The unique ID for this rule.
images_filter
array[String] DEPRECATED: A list of image IDs to be processed by the rule. If the array is empty, it implies include all. If <code>exclude_images_filter</code> is true, this list describes images to exclude.
match
String DEPRECATED: A regular expression applied to the branch or tag name depending on the value of <code>update_to</code>. Defaults to match all if omitted or empty.
match_ref
String A regular expression applied to the ref of a new artefact version. Defaults to match all if omitted or empty.
type
String Specifies the type of event. Currently, only updates to either branches or tags are supported. Must be <code>"update"</code>.
update_to
String DEPRECATED: Specifies whether the update occurs on commit to branch or creation of tag. Must be one of <code>"branch"</code> or <code>"tag"</code>.
updated_at
String The timestamp in UTC of when the Automation Rule was updated.
example: 2020-06-22T09:37:23.523Z
Credentials to authenticate Azure Key Vault.
client_id (optional)
client_secret (optional)
Azure Key Vault specification.
auth (optional)
tenant_id (optional)
url (optional)
Azure Key Vault specification.
tenant_id (optional)
url (optional)
ClusterSecret represents Kubernetes secret reference.
namespace
String Namespace to look for the Kubernetes secret definition in.
secret
String Name that identifies the Kubernetes secret.
ClusterSecret represents Kubernetes secret reference.
namespace
String Namespace to look for the Kubernetes secret definition in.
secret
String Name that identifies the Kubernetes secret.
ClusterSecretsMap stores a list of Kuberenetes secret references for the target deployment clusters.
ClusterSecretsMap stores a list of Kuberenetes secret references for the target deployment clusters.
Controller represents deployment, stateful set etc
kind (optional)
message (optional)
pods (optional)
replicas (optional)
revision (optional)
status (optional)
Controller represents deployment, stateful set etc
kind
message
pods
replicas
revision
status
CreateDriverRequest describes the new resource driver registration request.
account_types
array[String] List of resources accounts types supported by the driver
id (optional)
String The ID for this driver. Is used as <code>driver_type</code>.
inputs_schema
target
String The prefix where the driver resides or, if the driver is a virtual driver, the reference to an existing driver using the <code>driver://</code> schema of the format <code>driver://{orgId}/{driverId}</code>. Only members of the organization the driver belongs to can see 'target'.
template (optional)
If the driver is a virtual driver, template defines a Go template that converts the driver inputs supplied in the resource definition into the driver inputs for the target driver.
type
String The type of resource produced by this driver
CreateResourceAccountRequest describes the request to create a new security account.
credentials (optional)
id (optional)
String Unique identifier for the account (in scope of the organization it belongs to).
name (optional)
type (optional)
String The type of the account
CreateResourceDefinitionRequest describes a new ResourceDefinition request.
criteria (optional)
driver_account (optional)
String (Optional) Security account required by the driver.
driver_inputs (optional)
driver_type
String The driver to be used to create the resource.
id
String The Resource Definition ID.
name
provision (optional)
map[String, ProvisionDependenciesRequest] (Optional) A map where the keys are resType#resId (if resId is omitted, the same id of the current resource definition is used) of the resources that should be provisioned when the current resource is provisioned. This also specifies if the resources have a dependency on the current resource.
type
Secret Store represents external secret management system used by an organization to store secrets referenced in Humanitec. It must contain exactly one of the following elements to define Secret Store specification: <code>awssm</code> (AWS Secret Manager), <code>azurekv</code> (Azure Key Vault), <code>gcpsm</code> (GCP Secret Manager), <code>vault</code> (HashiCorp Vault).
awssm (optional)
azurekv (optional)
gcpsm (optional)
id
primary
Boolean Defines whether the Secret Store is the primary secret management system for the organization.
vault (optional)
archived (optional)
contributers (optional)
created_at (optional)
example: 2020-06-22T09:37:23.523Z
created_by (optional)
env_id (optional)
last_modified_at (optional)
example: 2020-06-22T09:37:23.523Z
name (optional)
shared (optional)
archived
contributers (optional)
created_at
example: 2020-06-22T09:37:23.523Z
created_by
env_id (optional)
last_modified_at
example: 2020-06-22T09:37:23.523Z
name (optional)
shared (optional)
<p>A Deployment Delta (or just "Delta") describes the changes that must be applied to one Deployment Set to generate another Deployment Set. Deployment Deltas are the only way to create new Deployment Sets.</p>
<p>Deployment Deltas can be created fully formed or combined together via PATCHing. They can also be generated from the difference between two Deployment Sets.</p>
<p><strong>Basic Structure</strong></p>
<pre><code> {
"id": <ID of the Deployment Delta.>,
"metadata": {
<Properties such as who created the Delta, which Environment it is associated to and a Human-friendly name>
}
"modules" : {
"add" : {
<ID of Module to add to the Deployment Set> : {
<An entire Modules object>
}
},
"remove": [
<An array of Module IDs that should be removed from the Deployment Set>
],
"update": {
<ID of Module already in the Set to be updated> : [
<An array of JSON Patch (Search Results (RFC 6902) objects scoped to the module>
]
}
}
}
</code></pre>
id (optional)
String Ignored, but can be provided.
metadata (optional)
modules (optional)
shared (optional)
<p>A Deployment Delta (or just "Delta") describes the changes that must be applied to one Deployment Set to generate another Deployment Set. Deployment Deltas are the only way to create new Deployment Sets.</p>
<p>Deployment Deltas can be created fully formed or combined together via PATCHing. They can also be generated from the difference between two Deployment Sets.</p>
<p><strong>Basic Structure</strong></p>
<pre><code> {
"id": <ID of the Deployment Delta.>,
"metadata": {
<Properties such as who created the Delta, which Environment it is associated to and a Human-friendly name>
}
"modules" : {
"add" : {
<ID of Module to add to the Deployment Set> : {
<An entire Modules object>
}
},
"remove": [
<An array of Module IDs that should be removed from the Deployment Set>
],
"update": {
<ID of Module already in the Set to be updated> : [
<An array of JSON Patch (Search Results (RFC 6902) objects scoped to the module>
]
}
}
}
</code></pre>
id
String A unique ID for the Delta
metadata
modules
shared
<p>A deploy condition for the workload</p>
<p>Possible values for "when" are: - "before", deployed before other workloads - "deploy", deployed in-parallel with other workloads (default) - "after", deployed after other workloads</p>
<p>Possible values for "success" are: - "deploy", workload deployed - "available", workload available - "complete", workload complete (often used with jobs)</p>
success (optional)
timeout (optional)
when (optional)
<p>A deploy condition for the workload</p>
<p>Possible values for "when" are: - "before", deployed before other workloads - "deploy", deployed in-parallel with other workloads (default) - "after", deployed after other workloads</p>
<p>Possible values for "success" are: - "deploy", workload deployed - "available", workload available - "complete", workload complete (often used with jobs)</p>
Error happening during deployment.
code (optional)
error_type (optional)
message (optional)
object_id (optional)
scope (optional)
summary (optional)
Error happening during deployment.
code
error_type
message
object_id
scope
summary
<p>Deployments represent updates to the running state of an Environment.</p>
<p>Deployments are made by applying <em>Deltas</em> to a state defined by an existing Deployment. The Environment’s from_deploy property defines the Deployment. This Deployment is usually but not always in the current Environment. If the Deployment is from another Environment, the state of that Environment will be "cloned" into the current Environment with the option to apply a Delta.</p>
comment (optional)
String An optional comment to help communicate the purpose of the Deployment.
delta_id (optional)
String ID of the Deployment Delta describing the changes to the current Environment for this Deployment.
set_id (optional)
String ID of the Deployment Set describing the state of the Environment after Deployment.
value_set_version_id (optional)
String ID of the Value Set Version describe the values to be used for this Deployment.
<p>Deployments represent updates to the running state of an Environment.</p>
<p>Deployments are made by applying <em>Deltas</em> to a state defined by an existing Deployment. The Environment’s from_deploy property defines the Deployment. This Deployment is usually but not always in the current Environment. If the Deployment is from another Environment, the state of that Environment will be "cloned" into the current Environment with the option to apply a Delta.</p>
comment
String An optional comment to help communicate the purpose of the Deployment.
created_at
String The Timestamp of when the Deployment was initiated.
example: 2020-06-22T09:37:23.523Z
created_by
String The user who initiated the Deployment.
delta_id (optional)
String ID of the Deployment Delta describing the changes to the current Environment for this Deployment.
env_id
String The Environment where the Deployment occurred.
export_file
export_status
from_id
String The ID of the Deployment that this Deployment was based on.
id
String The ID of the Deployment.
set_id
String ID of the Deployment Set describing the state of the Environment after Deployment.
status
String The current status of the Deployment. Can be <code>pending</code>, <code>in progress</code>, <code>succeeded</code>, or <code>failed</code>.
status_changed_at
String The timestamp of the last <code>status</code> change. If <code>status</code> is <code>succeeded</code> or <code>failed</code> it it will indicate when the Deployment finished.
example: 2020-06-22T09:37:23.523Z
value_set_version_id (optional)
String ID of the Value Set Version describe the values to be used for this Deployment.
<p>DriverDefinition describes the resource driver.</p>
<p>Resource Drivers are code that fulfils the Humanitec Resource Driver Interface. This interface allows for certain actions to be performed on resources such as creation and destruction. Humanitec provides numerous Resource Drivers “out of the box”. It is also possible to use 3rd party Resource Drivers or write your own.</p>
account_types (optional)
array[String] List of resources accounts types supported by the driver
id (optional)
String The ID for this driver. Is used as <code>driver_type</code>.
inputs_schema (optional)
org_id (optional)
String The Organization this driver exists under. Useful as public drivers are accessible to other orgs.
target (optional)
String The prefix where the driver resides or, if the driver is a virtual driver, the reference to an existing driver using the <code>driver://</code> schema of the format <code>driver://{orgId}/{driverId}</code>. Only members of the organization the driver belongs to can see <code>target</code>.
template (optional)
If the driver is a virtual driver, template defines a Go template that converts the driver inputs supplied in the resource definition into the driver inputs for the target driver.
type (optional)
String The type of resource produced by this driver
<p>DriverDefinition describes the resource driver.</p>
<p>Resource Drivers are code that fulfils the Humanitec Resource Driver Interface. This interface allows for certain actions to be performed on resources such as creation and destruction. Humanitec provides numerous Resource Drivers “out of the box”. It is also possible to use 3rd party Resource Drivers or write your own.</p>
account_types
array[String] List of resources accounts types supported by the driver
id
String The ID for this driver. Is used as <code>driver_type</code>.
inputs_schema
org_id
String The Organization this driver exists under. Useful as public drivers are accessible to other orgs.
target (optional)
String The prefix where the driver resides or, if the driver is a virtual driver, the reference to an existing driver using the <code>driver://</code> schema of the format <code>driver://{orgId}/{driverId}</code>. Only members of the organization the driver belongs to can see <code>target</code>.
template (optional)
If the driver is a virtual driver, template defines a Go template that converts the driver inputs supplied in the resource definition into the driver inputs for the target driver.
type
String The type of resource produced by this driver
id
String The ID the Environment is referenced as.
name
String The Human-friendly name for the Environment.
type
String The Environment Type. This is used for organizing and managing Environments.
id
String The ID the Environment is referenced as.
name
String The Human-friendly name for the Environment.
type
String The Environment Type. This is used for organizing and managing Environments.
from_deploy_id
String Defines the existing Deployment the new Environment will be based on.
id
String The ID the Environment is referenced as.
name
String The Human-friendly name for the Environment.
type
String The Environment Type. This is used for organizing and managing Environments.
Environments are independent spaces where Applications can run. An Application is always deployed into an Environment.
id
String The ID the Environment is referenced as.
name
String The Human-friendly name for the Environment.
type
String The Environment Type. This is used for organizing and managing Environments.
Environments are independent spaces where Applications can run. An Application is always deployed into an Environment.
created_at
String The timestamp in UTC of when the Environment was created.
example: 2020-06-22T09:37:23.523Z
created_by
String The user who created the Environment
from_deploy (optional)
id
String The ID the Environment is referenced as.
last_deploy (optional)
name
String The Human-friendly name for the Environment.
type
String The Environment Type. This is used for organizing and managing Environments.
EnvironmentRuntimeInfo
error (optional)
id
paused
status (optional)
<p>Environment Types are a way of grouping and managing Environments. Every Environment has exactly 1 Environment Type.</p>
<p>Environment Types can be used with External Resources to manage where resources such as databases are provisioned or even which cluster to deploy to.</p>
description (optional)
String A Human-readable description of the Environment Type
id
String The ID of the Environment Type. (Must be unique within an Organization.)
<p>Environment Types are a way of grouping and managing Environments. Every Environment has exactly 1 Environment Type.</p>
<p>Environment Types can be used with External Resources to manage where resources such as databases are provisioned or even which cluster to deploy to.</p>
description
String A Human-readable description of the Environment Type
id
String The ID of the Environment Type. (Must be unique within an Organization.)
ErrorInfo is returned by a handler in case of an error.
A standard error response
error
String A short code representing the class of error. This code can be used for tracking and observability or to
find appropriate troubleshooting documentation.
example: API-000
message
String A human-readable explanation of the error.
example: Something happened!
details (optional)
Properties which identify an event .
scope (optional)
type (optional)
Properties which identify an event .
Events available for triggering automated jobs.
properties
array[String] List of event properties which can be used as variables for this event
scope
type
Credentials to authenticate GCP Secret Manager.
secret_access_key (optional)
GCP Secret Manager specification.
auth (optional)
project_id (optional)
GCP Secret Manager specification.
HumanitecError represents a standard Humanitec Error
details (optional)
error
String A short code to help with error identification.
message
String A Human readable message about the error.
status_code (optional)
HumanitecPublicKey stores a Public Key Humanitec shared with an organization.
id
pub_key
active
created_at
example: 2020-06-22T09:37:23.523Z
updated_at
example: 2020-06-22T09:37:23.523Z
expired_at
example: 2020-06-22T09:37:23.523Z
Humanitec built-in Secret Store specification.
Humanitec built-in Secret Store specification.
<p>DEPRECATED: This type exists for historical compatibility and should not be used. Please use the <a href="https://api-docs.humanitec.com/#tag/Artefact">Artefact API</a> instead.</p>
<p>Holds the metadata associated withe a Container Image Build</p>
branch (optional)
String The branch name of the branch the build was built on
commit (optional)
String The commit ID that this build was built from.
image (optional)
String The fully qualified Image URL including registry, repository and tag.
tags (optional)
<p>DEPRECATED: This type exists for historical compatibility and should not be used. Please use the <a href="https://api-docs.humanitec.com/#tag/Artefact">Artefact API</a> instead.</p>
<p>Holds the metadata associated withe a Container Image Build</p>
added_at (optional)
String The time when the build was added to Humanitec.
example: 2020-06-22T09:37:23.523Z
branch
String The branch name of the branch the build was built on
commit
String The commit ID that this build was built from.
image
String The fully qualified Image URL including registry, repository and tag.
tags
<p>DEPRECATED: This type exists for historical compatibility and should not be used. Please use the <a href="https://api-docs.humanitec.com/#tag/Artefact">Artefact API</a> instead.</p>
<p>Container Images (known simply as Images) can be registered with Humanitec. Continuous Integration (CI) pipelines can then notify Humanitec when a new build of a Container Image becomes available. Humanitec tracks the Image along with metadata about how it was built.</p>
added_at (optional)
String The time the first build of this Image was added to the organization
example: 2020-06-22T09:37:23.523Z
builds (optional)
id (optional)
String The ID used to group different builds of the same Image together.
source (optional)
String The Image Source that this Image is added via
<p>DEPRECATED: This type exists for historical compatibility and should not be used. Please use the <a href="https://api-docs.humanitec.com/#tag/Artefact">Artefact API</a> instead.</p>
<p>Container Images (known simply as Images) can be registered with Humanitec. Continuous Integration (CI) pipelines can then notify Humanitec when a new build of a Container Image becomes available. Humanitec tracks the Image along with metadata about how it was built.</p>
added_at
String The time the first build of this Image was added to the organization
example: 2020-06-22T09:37:23.523Z
builds
id
String The ID used to group different builds of the same Image together.
source
String The Image Source that this Image is added via
ImagesRegistryCreds stores registry credentials details alongside with associated images.
images
registry
String Registry name, usually in a "{domain}" or "{domain}/{project}" format.
secrets (optional)
ImagesRegistryCreds stores registry credentials details alongside with associated images.
images
registry
String Registry name, usually in a "{domain}" or "{domain}/{project}" format.
secrets
op (optional)
path (optional)
value (optional)
dark_url (optional)
light_url (optional)
Manifest represents a complete or a partial Kubernetes manifest, and a location for its injection.
data (optional)
location (optional)
String Location to inject the Manifest at.
Manifest represents a complete or a partial Kubernetes manifest, and a location for its injection.
data
location
String Location to inject the Manifest at.
<p>Matching Criteria are a set of rules used to choose which Resource Definition to use to provision a particular Resource Type.</p>
<p>Matching criteria are made up in order of specificity with least specific first:</p>
<ul>
<li>
<p>Environment Type (<code>env_type</code>)</p>
</li>
<li>
<p>Application (<code>app_id</code>)</p>
</li>
<li>
<p>Environment (<code>env_id</code>)</p>
</li>
<li>
<p>Resource (<code>res_id</code>)</p>
</li>
</ul>
<p>When selecting matching criteria, the most specific one is selected. In general, this means of all the Matching Criteria fully matching the context, the Matching Criteria Rule with the most specific element filled is chosen. If there is a tie, the next most specific elements are compared and so on until one is chosen.</p>
<p><strong>NOTE:</strong></p>
<p>Humanitec will reject the registration of matching criteria rules that duplicate rules already present for a Resource Type.</p>
app_id (optional)
String (Optional) The ID of the Application that the Resources should belong to.
class (optional)
String (Optional) The class of the Resource in the Deployment Set. Can not be empty, if is not defined, set to <code>default</code>.
env_id (optional)
String (Optional) The ID of the Environment that the Resources should belong to. If <code>env_type</code> is also set, it must match the Type of the Environment for the Criteria to match.
env_type (optional)
String (Optional) The Type of the Environment that the Resources should belong to. If <code>env_id</code> is also set, it must have an Environment Type that matches this parameter for the Criteria to match.
id (optional)
res_id (optional)
String (Optional) The ID of the Resource in the Deployment Set. The ID is normally a <code>.</code> separated path to the definition in the set, e.g. <code>modules.my-module.externals.my-database</code>.
<p>Matching Criteria are a set of rules used to choose which Resource Definition to use to provision a particular Resource Type.</p>
<p>Matching criteria are made up in order of specificity with least specific first:</p>
<ul>
<li>
<p>Environment Type (<code>env_type</code>)</p>
</li>
<li>
<p>Application (<code>app_id</code>)</p>
</li>
<li>
<p>Environment (<code>env_id</code>)</p>
</li>
<li>
<p>Resource (<code>res_id</code>)</p>
</li>
</ul>
<p>When selecting matching criteria, the most specific one is selected. In general, this means of all the Matching Criteria fully matching the context, the Matching Criteria Rule with the most specific element filled is chosen. If there is a tie, the next most specific elements are compared and so on until one is chosen.</p>
<p><strong>NOTE:</strong></p>
<p>Humanitec will reject the registration of matching criteria rules that duplicate rules already present for a Resource Type.</p>
app_id (optional)
String (Optional) The ID of the Application that the Resources should belong to.
class
String (Optional) The class of the Resource in the Deployment Set. Can not be empty, if is not defined, set to <code>default</code>.
env_id (optional)
String (Optional) The ID of the Environment that the Resources should belong to. If <code>env_type</code> is also set, it must match the Type of the Environment for the Criteria to match.
env_type (optional)
String (Optional) The Type of the Environment that the Resources should belong to. If <code>env_id</code> is also set, it must have an Environment Type that matches this parameter for the Criteria to match.
id
res_id (optional)
String (Optional) The ID of the Resource in the Deployment Set. The ID is normally a <code>.</code> separated path to the definition in the set, e.g. <code>modules.my-module.externals.my-database</code>.
MatchingCriteriaRule describes Matching Criteria rules.
app_id (optional)
String (Optional) The ID of the Application that the Resources should belong to.
class (optional)
String (Optional) The class of the Resource in the Deployment Set. Can not be empty, if is not defined, set to <code>default</code>.
env_id (optional)
String (Optional) The ID of the Environment that the Resources should belong to. If <code>env_type</code> is also set, it must match the Type of the Environment for the Criteria to match.
env_type (optional)
String (Optional) The Type of the Environment that the Resources should belong to. If <code>env_id</code> is also set, it must have an Environment Type that matches this parameter for the Criteria to match.
res_id (optional)
String (Optional) The ID of the Resource in the Deployment Set. The ID is normally a <code>.</code> separated path to the definition in the set, e.g. <code>modules.my-module.externals.my-database</code>.
ModuleDeltas groups the different operations together.
add (optional)
remove (optional)
update (optional)
ModuleDeltas groups the different operations together.
Module represents a collection of workload controllers (deployments/statefulsets/etc) for the module
Module represents a collection of workload controllers (deployments/statefulsets/etc) for the module
NewServiceUser holds the definition of a new service user.
email (optional)
String The email address that should get notifications about this service user. (Optional)
name
String The name that should be shown for this service user.
role
String The role that the service user should have on the organization it is created in
NodeBody represents a node of a Resource Dependency Graph.
class
criteria_id
def_id
depends_on
driver
driver_type
guresid
id
resource
resource_schema
target (optional)
type
An Organization is the top level object in Humanitec. All other objects belong to an Organization.
id (optional)
String Unique ID for the Organization.
name (optional)
String Human friendly name for the Organization.
An Organization is the top level object in Humanitec. All other objects belong to an Organization.
created_at
String Timestamp when the Organization was created.
example: 2020-06-22T09:37:23.523Z
created_by
String User ID that created the Organization.
id
String Unique ID for the Organization.
logo (optional)
name
String Human friendly name for the Organization.
PatchResourceDefinitionRequest describes a ResourceDefinition change request.
driver_account (optional)
String (Optional) Security account required by the driver.
driver_inputs (optional)
name (optional)
String (Optional) Resource display name
provision (optional)
map[String, ProvisionDependenciesRequest] (Optional) A map where the keys are resType#resId (if resId is omitted, the same id of the current resource definition is used) of the resources that should be provisioned when the current resource is provisioned. This also specifies if the resources have a dependency on the current resource or if they have the same dependent resources.
An object containing the details of a Pipeline.
id
String The id of the Pipeline.
example: sample-pipeline
etag
String The current entity tag value for this Pipeline.
example: 1234567890abcdef
org_id
String The id of the Organization containing this Pipeline.
example: sample-org
app_id
String The id of the Application containing this Pipeline.
example: sample-app
name
String The name of the Pipeline.
example: Sample Pipeline
status
String The current status of the Pipeline.
example: active
version
String The unique id of the current Pipeline Version.
example: 01234567-89ab-cdef-0123-456789abcdef
created_at
Date The date and time when the Pipeline was created. format: date-time
example: 2023-01-01T00:00Z
trigger_types
example: ["pipeline_call"]
metadata (optional)
An object containing the details of a Pipeline.
id
String The unique id of the current Pipeline Version.
example: 01234567-89ab-cdef-0123-456789abcdef
org_id
String The id of the Organization containing this Run.
example: sample-org
app_id
String The id of the Application containing this Run.
example: sample-app
pipeline_id
String The id of the Pipeline associated with the Run.
example: sample-pipeline
created_by
String User id of the pipeline version.
example: 01234567-89ab-cdef-0123-456789abcdef
created_at
Date The date and time when the specific pipeline version was created. format: date-time
example: 2023-01-01T00:00Z
<p>Similar to the delta response, except the id and metadata properties.</p>
<p><strong>Basic Structure</strong></p>
<pre><code> {
"modules" : {
"add" : {
<ID of Module to add to the Deployment Set> : {
<An entire Modules object>
}
},
"remove": [
<An array of Module IDs that should be removed from the Deployment Set>
],
"update": {
<ID of Module already in the Set to be updated> : [
<An array of JSON Patch (Search Results (RFC 6902) objects scoped to the module>
]
}
}
}
</code></pre>
PodState represents single pod status
containerStatuses (optional)
phase (optional)
podName (optional)
revision (optional)
status (optional)
PodState represents single pod status
containerStatuses
phase
podName
revision
status
ProvisionDependencies defines resources which are needed to be co-provisioned with the current resource.
is_dependent (optional)
Boolean If the co-provisioned resource is dependendent on the current one.
match_dependents (optional)
Boolean If the resources dependant on the main resource, are also dependant on the co-provisioned one.
ProvisionDependencies defines resources which are needed to be co-provisioned with the current resource.
is_dependent
Boolean If the co-provisioned resource is dependendent on the current one.
match_dependents (optional)
Boolean If the resources dependant on the main resource, are also dependant on the co-provisioned one.
PublicKey stores a Public Key an organization shares with Humanitec.
id
key
created_at
example: 2020-06-22T09:37:23.523Z
created_by
expired_at
example: 2020-06-22T09:37:23.523Z
fingerprint
String Key is the sha256 public key fingerprint, it's computed and stored when a new key is uploaded.
RegistryCreds represents current registry credentials (either, username- or token-based).
expires (optional)
String Account credentials expiration timestamp.
example: 2020-06-22T09:37:23.523Z
password
String Account password or token secret.
registry
String Registry name, usually in a "{domain}" or "{domain}/{project}" format.
secrets
username
String Security account login or token.
<p>Humanitec can be used to manage registry credentials. The Registry object represents how to match credentials to a particular registry.</p>
<p>Humanitec supports all Docker compatible registries as well as the custom authentication formats used by AWS Elastic Container Registry and Google Container Registry. It also supports the injection of a specific secret to be copied from an existing namespace in the cluster.</p>
creds (optional)
enable_ci (optional)
Boolean Indicates if registry secrets and credentials should be exposed to CI agents.
id
String Registry ID, unique within the Organization.
registry
String Registry name, usually in a "{domain}" or "{domain}/{project}" format.
secrets (optional)
type
String <p>Registry type, describes the registry authentication method, and defines the schema for the credentials.</p>
<p>Supported values:</p>
<ul>
<li>
<p><code>public</code></p>
</li>
<li>
<p><code>basic</code></p>
</li>
<li>
<p><code>google_gcr</code></p>
</li>
<li>
<p><code>amazon_ecr</code></p>
</li>
<li>
<p><code>secret_ref</code></p>
</li>
</ul>
<p>Humanitec can be used to manage registry credentials. The Registry object represents how to match credentials to a particular registry.</p>
<p>Humanitec supports all Docker compatible registries as well as the custom authentication formats used by AWS Elastic Container Registry and Google Container Registry. It also supports the injection of a specific secret to be copied from an existing namespace in the cluster.</p>
created_at (optional)
String The timestamp of when this record was created.
example: 2020-06-22T09:37:23.523Z
created_by (optional)
String The user who created this record.
enable_ci
Boolean Indicates if registry secrets and credentials should be exposed to CI agents.
id
String Registry ID, unique within the Organization.
registry
String Registry name, usually in a "{domain}" or "{domain}/{project}" format.
secrets (optional)
type
String <p>Registry type, describes the registry authentication method, and defines the schema for the credentials.</p>
<p>Supported values:</p>
<ul>
<li>
<p><code>public</code></p>
</li>
<li>
<p><code>basic</code></p>
</li>
<li>
<p><code>google_gcr</code></p>
</li>
<li>
<p><code>amazon_ecr</code></p>
</li>
<li>
<p><code>secret_ref</code></p>
</li>
</ul>
<p>ResourceAccount represents the account being used to access a resource.</p>
<p>Resource Accounts hold credentials that are required to provision and manage resources.</p>
created_at (optional)
String The timestamp of when the account was created.
example: 2020-06-22T09:37:23.523Z
created_by (optional)
String The ID of the user who created the account.
id (optional)
String Unique identifier for the account (in scope of the organization it belongs to).
is_used (optional)
Boolean Indicates if this account is being used (referenced) by any resource definition.
name (optional)
type (optional)
String The type of the account
<p>ResourceAccount represents the account being used to access a resource.</p>
<p>Resource Accounts hold credentials that are required to provision and manage resources.</p>
created_at
String The timestamp of when the account was created.
example: 2020-06-22T09:37:23.523Z
created_by
String The ID of the user who created the account.
id
String Unique identifier for the account (in scope of the organization it belongs to).
is_used
Boolean Indicates if this account is being used (referenced) by any resource definition.
name
type
String The type of the account
ResourceDefinitionChange describes the effects of a Resource Definition or Matching Criteria update/deletion.
app_id
String The ID of the App the resource is associated with.
env_id
String The ID of the Environment the resource is associated with.
from_def
String The Resource Definition that this resource was provisioned from.
res_id
to_def
String The Resource Definition that resource <em>will be</em> provisioned from if the change is applied.
<p>A Resource Definitions describes how and when a resource should be provisioned. It links a driver (the how) along with a Matching Criteria (the when) to a Resource Type. This allows Humanitec to invoke a particular driver for the required Resource Type in the context of a particular Application and Environment.</p>
<p>The schema for the <code>driver_inputs</code> is defined by the <code>input_schema</code> property on the DriverDefinition identified by the <code>driver_type</code> property.</p>
created_at (optional)
String The timestamp of when this record has been created.
example: 2020-06-22T09:37:23.523Z
created_by (optional)
String The user who created this record.
criteria (optional)
driver_account (optional)
String (Optional) Security account required by the driver.
driver_inputs (optional)
driver_type (optional)
String The driver to be used to create the resource.
id (optional)
String The Resource Definition ID.
is_default (optional)
Boolean Indicates this definition is a built-in one (provided by Humanitec).
is_deleted (optional)
Boolean Indicates if this record has been marked for deletion. The Resource Definition that has been marked for deletion cannot be used to provision new resources.
name (optional)
org_id (optional)
provision (optional)
map[String, ProvisionDependenciesRequest] (Optional) A map where the keys are resType#resId (if resId is omitted, the same id of the current resource definition is used) of the resources that should be provisioned when the current resource is provisioned. This also specifies if the resources have a dependency on the current resource.
type (optional)
<p>A Resource Definitions describes how and when a resource should be provisioned. It links a driver (the how) along with a Matching Criteria (the when) to a Resource Type. This allows Humanitec to invoke a particular driver for the required Resource Type in the context of a particular Application and Environment.</p>
<p>The schema for the <code>driver_inputs</code> is defined by the <code>input_schema</code> property on the DriverDefinition identified by the <code>driver_type</code> property.</p>
created_at (optional)
String The timestamp of when this record has been created.
example: 2020-06-22T09:37:23.523Z
created_by (optional)
String The user who created this record.
criteria (optional)
driver_account (optional)
String (Optional) Security account required by the driver.
driver_inputs (optional)
driver_type (optional)
String The driver to be used to create the resource.
id
String The Resource Definition ID.
is_default (optional)
Boolean Indicates this definition is a built-in one (provided by Humanitec).
is_deleted (optional)
Boolean Indicates if this record has been marked for deletion. The Resource Definition that has been marked for deletion cannot be used to provision new resources.
name
org_id
provision (optional)
map[String, ProvisionDependenciesResponse] (Optional) A map where the keys are resType#resId (if resId is omitted, the same id of the current resource definition is used) of the resources that should be provisioned when the current resource is provisioned. This also specifies if the resources have a dependency on the current resource.
type
ResourceProvisionRequest is the payload passed to the resource provisioner, specifying the resources to be provisioned.
class (optional)
String (Optional) A resource class
id
resource (optional)
map[String, Object] (Optional) The input parameters for the resource passed from the deployment set.
type
<p>Resources Types define the technology that Applications can have dependencies on.</p>
<p>Each Resource Type also defines a set of input parameters (<code>inputs_schema</code>), and a set of output data (<code>outputs_schema</code>). When provisioning a resource, these are treated as inputs and outputs respectively.</p>
category (optional)
String Category name (used to group similar resources on the UI).
inputs_schema (optional)
map[String, Object] A JSON Schema specifying the type-specific parameters for the driver (input).
name (optional)
outputs_schema (optional)
map[String, Object] A JSON Schema specifying the type-specific data passed to the deployment (output).
type
String Unique resource type identifier (system-wide, across all organizations).
use
String Kind of dependency between resource of this type and a workload. It should be one of: <code>direct</code>, <code>indirect</code>, <code>implicit</code>.
<p>Resources Types define the technology that Applications can have dependencies on.</p>
<p>Each Resource Type also defines a set of input parameters (<code>inputs_schema</code>), and a set of output data (<code>outputs_schema</code>). When provisioning a resource, these are treated as inputs and outputs respectively.</p>
category
String Category name (used to group similar resources on the UI).
inputs_schema
map[String, Object] A JSON Schema specifying the type-specific parameters for the driver (input).
name
outputs_schema
map[String, Object] A JSON Schema specifying the type-specific data passed to the deployment (output).
type
String Unique resource type identifier (system-wide, across all organizations).
use
String Kind of dependency between resource of this type and a workload. It should be one of: <code>direct</code>, <code>indirect</code>, <code>implicit</code>.
Role defines the role that will be used in request
The parameters for creating a new Run for the Pipeline.
inputs (optional)
example: {"fizz":"buzz"}
Details of a Job within the Run.
id (optional)
String The id of the Job within the Run.
example: 01234567-89ab-cdef-0123-456789abcdef
etag (optional)
String The current entity tag value for this Job.
example: 1234567890abcdef
org_id (optional)
String The id of the Organization containing this Job.
example: sample-org
app_id (optional)
String The id of the Application containing this Job.
example: sample-app
pipeline_id (optional)
String The id of the Pipeline.
example: sample-pipeline
pipeline_version (optional)
String The id of the Pipeline Version associated with the Run.
example: 01234567-89ab-cdef-0123-456789abcdef
run_id (optional)
String The id of the Run containing this Job.
example: 01234567-89ab-cdef-0123-456789abcdef
status (optional)
String The current status of this Job.
example: executing
waiting_for (optional)
String An event on which job is waiting
example: application.environment.deployment(test-deployment-id)
status_message (optional)
String A human-readable message indicating the reason for the status.
example: Example text
created_at (optional)
Date The date and time when this Job was first created within the Run. format: date-time
example: 2023-01-01T00:00Z
cancellation_requested_at (optional)
Date The date and time when cancellation of this Job was requested. format: date-time
example: 2023-01-01T00:00Z
completed_at (optional)
Date The date and time when this Job entered a successful, failed, or cancelled status. format: date-time
example: 2023-01-01T00:00Z
timeout_seconds (optional)
example: 3600
A response containing all of the details of an executing or completed Job including Step information.
id (optional)
String The id of the Job within the Run.
example: 01234567-89ab-cdef-0123-456789abcdef
etag (optional)
String The current entity tag value for this Job.
example: 1234567890abcdef
org_id (optional)
String The id of the Organization containing this Job.
example: sample-org
app_id (optional)
String The id of the Application containing this Job.
example: sample-app
pipeline_id (optional)
String The id of the Pipeline.
example: sample-pipeline
pipeline_version (optional)
String The id of the Pipeline Version associated with the Run.
example: 01234567-89ab-cdef-0123-456789abcdef
run_id (optional)
String The id of the Run containing this Job.
example: 01234567-89ab-cdef-0123-456789abcdef
status (optional)
String The current status of this Job.
example: executing
waiting_for (optional)
String An event on which job is waiting
example: application.environment.deployment(test-deployment-id)
status_message (optional)
String A human-readable message indicating the reason for the status.
example: Example text
created_at (optional)
Date The date and time when this Job was first created within the Run. format: date-time
example: 2023-01-01T00:00Z
cancellation_requested_at (optional)
Date The date and time when cancellation of this Job was requested. format: date-time
example: 2023-01-01T00:00Z
completed_at (optional)
Date The date and time when this Job entered a successful, failed, or cancelled status. format: date-time
example: 2023-01-01T00:00Z
timeout_seconds (optional)
example: 3600
steps (optional)
array[RunJobStep] The collection of Steps that completed along with the current Step being executed.
A Step within a Job.
index (optional)
Integer The index of the Step within the Pipeline Schema.
status (optional)
String The current status of this Step within the Job.
example: executing
status_message (optional)
String A human-readable message indicating the reason for the status.
example: Example text
created_at (optional)
Date The date and time when this Step was first created within the Job. format: date-time
example: 2023-01-01T00:00Z
completed_at (optional)
Date The date and time when this Step entered a successful, failed, or cancelled status. format: date-time
example: 2023-01-01T00:00Z
timeout_seconds (optional)
example: 3600
An item from the logs of a Step.
at
Date The date and time when this message was emitted or captured. format: date-time
example: 2023-01-01T00:00Z
level
String The log level of the message.
example: INFO
message
String The content of the message.
example: Example message
Details of a Run within the Pipeline.
id (optional)
String The unique id of the Run.
example: 01234567-89ab-cdef-0123-456789abcdef
etag (optional)
String The current entity tag value for this Run.
example: 1234567890abcdef
org_id (optional)
String The id of the Organization containing this Run.
example: sample-org
app_id (optional)
String The id of the Application containing this Run.
example: sample-app
pipeline_id (optional)
String The id of the Pipeline associated with the Run.
example: sample-pipeline
pipeline_version (optional)
String The id of the Pipeline Version associated with the Run.
example: 01234567-89ab-cdef-0123-456789abcdef
status (optional)
String The current status of this Run.
example: executing
status_message (optional)
String A human-readable message indicating the reason for the status.
example: Example text
created_at (optional)
Date The date and time when this Run was first created. format: date-time
example: 2023-01-01T00:00Z
executing_at (optional)
Date The date and time when this Run entered executing status. format: date-time
example: 2023-01-01T00:00Z
cancellation_requested_at (optional)
Date The date and time when cancellation of this Run was requested. format: date-time
example: 2023-01-01T00:00Z
completed_at (optional)
Date The date and time when this Run entered a successful, failed, or cancelled status. format: date-time
example: 2023-01-01T00:00Z
timeout_seconds (optional)
example: 3600
inputs (optional)
example: {"fizz":"buzz"}
run_as (optional)
String The user id that the pipeline run is executing as when it calls Humanitec APIs.
example: s-01234567-89ab-cdef-0123-456789abcdef
concurrency_group (optional)
String The optional concurrency group for this run within the application
example: my-group
waiting_for
RuntimeInfo object returned by the runtime endpoint. Represents a list post statuses grouped by modules and controllers (deployments and stateful sets).
modules (optional)
namespace (optional)
RuntimeInfo object returned by the runtime endpoint. Represents a list post statuses grouped by modules and controllers (deployments and stateful sets).
It stores sensitive value in the organization primary store or a reference to a sensitive value stored in a store registered under the organization.
store (optional)
String Secret Store id. This can't be <code>humanitec</code> (our internal Secret Store). It's mandatory if <code>ref</code> is defined and can't be used if <code>value</code> is defined.
ref (optional)
String Secret reference in the format of the target store. It can't be defined if <code>value</code> is defined.
version (optional)
String Optional, only valid if <code>ref</code> is defined. It's the version of the secret as defined in the target store.
value (optional)
String Value to store in the secret store. It can't be defined if <code>ref</code> is defined.
Secret Store represents external secret management system used by an organization to store secrets referenced in Humanitec.
awssm (optional)
azurekv (optional)
created_at (optional)
example: 2020-06-22T09:37:23.523Z
created_by (optional)
gcpsm (optional)
humanitec (optional)
id (optional)
primary (optional)
updated_at (optional)
example: 2020-06-22T09:37:23.523Z
updated_by (optional)
vault (optional)
Secret Store represents external secret management system used by an organization to store secrets referenced in Humanitec.
awssm (optional)
azurekv (optional)
created_at
example: 2020-06-22T09:37:23.523Z
created_by
gcpsm (optional)
humanitec (optional)
id
primary
updated_at
example: 2020-06-22T09:37:23.523Z
updated_by
vault (optional)
<p>A Deployment Set (or just "Set") defines all of the non-Environment specific configuration for Modules and External Resources. Each of these Modules or External Resources has a unique name.</p>
<p>Deployment Sets are immutable and their ID is a cryptographic hash of their content. This means that a Deployment Set can be globally identified based on its ID. It also means that referencing a Deployment Set by ID will always return the same Deployment Set.</p>
<p>Deployment Sets cannot be created directly, instead they are created by applying a Deployment Delta to an existing Deployment Set.</p>
<p><strong>Basic Structure</strong></p>
<pre><code> {
"id": <ID of the Deployment Set>,
"modules" : {
<ID of Module> : {
"profile": <Defines how the optional "spec" property is interpreted>
"spec": {
<Properties that depend on the "profile" property.>
}
"externals": {
<External Resource Name> : {
"type": <Resource Type>,
"params": {
<Properties which parametrize the resource depending on the Resource Type.>
}
}
}
}
}
}
</code></pre>
<p>For details about how the Humanitec provided profiles work, see (Deployment Set Profiles)[].</p>
modules (optional)
shared (optional)
version (optional)
Integer The version of the Deployment Set Schema to use. (Currently, only 0 is supported, and if omitted, version 0 is assumed.)
<p>A Deployment Set (or just "Set") defines all of the non-Environment specific configuration for Modules and External Resources. Each of these Modules or External Resources has a unique name.</p>
<p>Deployment Sets are immutable and their ID is a cryptographic hash of their content. This means that a Deployment Set can be globally identified based on its ID. It also means that referencing a Deployment Set by ID will always return the same Deployment Set.</p>
<p>Deployment Sets cannot be created directly, instead they are created by applying a Deployment Delta to an existing Deployment Set.</p>
<p><strong>Basic Structure</strong></p>
<pre><code> {
"id": <ID of the Deployment Set>,
"modules" : {
<ID of Module> : {
"profile": <Defines how the optional "spec" property is interpreted>
"spec": {
<Properties that depend on the "profile" property.>
}
"externals": {
<External Resource Name> : {
"type": <Resource Type>,
"params": {
<Properties which parametrize the resource depending on the Resource Type.>
}
}
}
}
}
}
</code></pre>
<p>For details about how the Humanitec provided profiles work, see (Deployment Set Profiles)[].</p>
id
String The ID which is a hash of the content of the Deployment Set.
modules
shared
version
Integer The version of the Deployment Set Schema to use. (Currently, only 0 is supported, and if omitted, version 0 is assumed.)
Defines the token to be created.
description (optional)
String A description of the token. (Optional)
expires_at (optional)
String The time the token expires. If not set, the token will not expire. (Optional)
example: 2020-06-22T09:37:23.523Z
id
String Identifier of the token. Must be unique for the user.
type
String The type of the token. Can only be "static".
Holds metadata about a token. <code>expires_at</code> is excluded if token does not expire.
created_at (optional)
example: 2020-06-22T09:37:23.523Z
created_by (optional)
description (optional)
expires_at (optional)
example: 2020-06-22T09:37:23.523Z
id (optional)
type (optional)
Holds metadata about a token. <code>expires_at</code> is excluded if token does not expire.
created_at
example: 2020-06-22T09:37:23.523Z
created_by
description
expires_at (optional)
example: 2020-06-22T09:37:23.523Z
id
type
Token holds the token and its type.
<p>A representation of the main object defined in JSON Patch specified in RFC 6902 from the IETF. The main differences are:</p>
<ul>
<li>
<p>Only <code>add</code>, <code>remove</code> and <code>replace</code> are supported</p>
</li>
<li>
<p><code>remove</code> can have have its scope of application applied in its <code>value</code>. e.g. `{"scope":"delta"}</p>
</li>
</ul>
from (optional)
op (optional)
path (optional)
value (optional)
<p>A representation of the main object defined in JSON Patch specified in RFC 6902 from the IETF. The main differences are:</p>
<ul>
<li>
<p>Only <code>add</code>, <code>remove</code> and <code>replace</code> are supported</p>
</li>
<li>
<p><code>remove</code> can have have its scope of application applied in its <code>value</code>. e.g. `{"scope":"delta"}</p>
</li>
</ul>
from (optional)
op
path
value (optional)
UpdateArtefactVersionPayload contains the <code>archived</code> field that should be set in the Artefact Version to update.
archived
Boolean The Value of the archived value.
UpdateDriverRequest describes the update driver details request.
account_types
array[String] List of resources accounts types supported by the driver
inputs_schema
target
String The prefix where the driver resides or, if the driver is a virtual driver, the reference to an existing driver using the <code>driver://</code> schema of the format <code>driver://{orgId}/{driverId}</code>. Only members of the organization the driver belongs to can see 'target'.
template (optional)
If the driver is a virtual driver, template defines a Go template that converts the driver inputs supplied in the resource definition into the driver inputs for the target driver.
type
String The type of resource produced by this driver
UpdateResourceAccountRequest describes the request to update the security account details.
credentials (optional)
name (optional)
UpdateResourceDefinitionRequest describes a ResourceDefinition change request.
driver_account (optional)
String (Optional) Security account required by the driver.
driver_inputs (optional)
name
provision (optional)
map[String, ProvisionDependenciesRequest] (Optional) A map where the keys are resType#resId (if resId is omitted, the same id of the current resource definition is used) of the resources that should be provisioned when the current resource is provisioned. This also specifies if the resources have a dependency on the current resource or if they have the same dependent resources.
Secret Store represents external secret management system used by an organization to store secrets referenced in Humanitec.
awssm (optional)
azurekv (optional)
gcpsm (optional)
primary (optional)
Boolean Defines whether the Secret Store is the primary secret management system for the organization.
vault (optional)
UserInviteRequest describes a new user invitation.
email
String The email address of the user from the profile.
role
String The role that this user would hold.
UserInvite stores the invitation details.
created_at
String The timestamp this invitation was created.
example: 2020-06-22T09:37:23.523Z
created_by
String The ID of the user who created this invitation.
email (optional)
String The email address of the user from the profile.
expires_at
String The timestamp this invitation would expire.
example: 2020-06-22T09:37:23.523Z
user_id
String The User ID for this user.
UserProfileExtended holds the profile information of a user including properties only accessible to the user.
created_at (optional)
String The time the user was first registered with Humanitec
example: 2020-06-22T09:37:23.523Z
email (optional)
String The email address of the user from the profile
id (optional)
String The User ID for this user
name (optional)
String The name the user goes by
properties (optional)
roles (optional)
type (optional)
String The type of the account. Could be user, service or system
UserProfileExtended holds the profile information of a user including properties only accessible to the user.
created_at
String The time the user was first registered with Humanitec
example: 2020-06-22T09:37:23.523Z
email (optional)
String The email address of the user from the profile
id
String The User ID for this user
name
String The name the user goes by
properties
roles
type
String The type of the account. Could be user, service or system
UserProfile holds the profile information of a user
created_at (optional)
String The time the user was first registered with Humanitec
example: 2020-06-22T09:37:23.523Z
email (optional)
String The email address of the user from the profile
id (optional)
String The User ID for this user
name (optional)
String The name the user goes by
type (optional)
String The type of the account. Could be user, service or system
UserProfile holds the profile information of a user
created_at
String The time the user was first registered with Humanitec
example: 2020-06-22T09:37:23.523Z
email (optional)
String The email address of the user from the profile
id
String The User ID for this user
name
String The name the user goes by
type
String The type of the account. Could be user, service or system
UserRole holds the mapping of role to user for a particular object.
role (optional)
String The role that this user holds
user (optional)
String The user ID that hold the role
created_at (optional)
String The time the user was first registered with Humanitec
example: 2020-06-22T09:37:23.523Z
email (optional)
String The email address of the user from the profile
id (optional)
String The User ID for this user
invite (optional)
String The status of an invitation (If applicable)
name (optional)
String The name the user goes by
type (optional)
String The type of the account. Could be user, service or system
UserRole holds the mapping of role to user for a particular object.
role
String The role that this user holds
user (optional)
String The user ID that hold the role
created_at
String The time the user was first registered with Humanitec
example: 2020-06-22T09:37:23.523Z
email (optional)
String The email address of the user from the profile
id
String The User ID for this user
invite (optional)
String The status of an invitation (If applicable)
name
String The name the user goes by
type
String The type of the account. Could be user, service or system
description
is_secret (optional)
key
value (optional)
secret_ref (optional)
description
value (optional)
is_secret (optional)
key (optional)
secret_ref (optional)
description (optional)
value (optional)
secret_ref (optional)
<p>Shared Values can be used to manage variables and configuration that might vary between environments. They are also the way that secrets can be stored securely.</p>
<p>Shared Values are by default shared across all environments in an application. However, they can be overridden on an Environment by Environment basis.</p>
<p>For example: There might be 2 API keys that are used in an application. One development key used in the development and staging environments and another used for production. The development API key would be set at the Application level. The value would then be overridden at the Environment level for the production Environment.</p>
description (optional)
String A Human friendly description of what the Shared Value is.
is_secret (optional)
Boolean Specified that the Shared Value contains a secret.
key (optional)
String The unique key by which the Shared Value can be referenced. pattern: ^[a-zA-Z0-9._-]+$.
value (optional)
String The value that will be stored. (Will be always empty for secrets.)
secret_ref (optional)
<p>Shared Values can be used to manage variables and configuration that might vary between environments. They are also the way that secrets can be stored securely.</p>
<p>Shared Values are by default shared across all environments in an application. However, they can be overridden on an Environment by Environment basis.</p>
<p>For example: There might be 2 API keys that are used in an application. One development key used in the development and staging environments and another used for production. The development API key would be set at the Application level. The value would then be overridden at the Environment level for the production Environment.</p>
created_at
example: 2020-06-22T09:37:23.523Z
description
String A Human friendly description of what the Shared Value is.
is_secret
Boolean Specified that the Shared Value contains a secret.
key
String The unique key by which the Shared Value can be referenced. pattern: ^[a-zA-Z0-9._-]+$.
secret_key
String Location of the secret value in the secret store.
secret_store_id
secret_version
String Version of the current secret value as returned by the secret store.
source
updated_at
example: 2020-06-22T09:37:23.523Z
value
String The value that will be stored. (Will be always empty for secrets.)
A Value Set Version can be used as a track record of Shared Values changes, to restore a previous version of a Shared Value or Value Set, or to purge a Shared Value if it shouldn't be accessible anymore.
change
comment
created_at
example: 2020-06-22T09:37:23.523Z
created_by
id
result_of
source_value_set_version_id
updated_at
example: 2020-06-22T09:37:23.523Z
values
Source of the value, "app" for app level, "env" for app env level.
ValuesSecretsRefs stores data that should be passed around split by sensitivity.
secret_refs (optional)
map[String, Object] <p>Secrets section of the data set. They can hold sensitive information that will be stored in the primary organization secret store and replaced with the secret store paths when sent outside, or secret references stored in a defined secret store. Can't be used together with <code>secrets</code>.</p>
<p>They can hold a nested structure but leaf objects need to be of type SecretReference, where:</p>
<ul>
<li>
<p><code>store</code> is a Secret Store id. It can't be <code>humanitec</code>. It's mandatory if <code>ref</code> is defined and can't be used in request payloads if <code>value</code> is defined.</p>
</li>
<li>
<p><code>ref</code> is the secret key in the format of the target store. It can't be used in request payloads if <code>value</code> is defined.</p>
</li>
<li>
<p><code>version</code> is the version of the secret as defined in the target store. It can be defined only if <code>ref</code> is defined.</p>
</li>
<li>
<p><code>value</code> is the value to store in the organizations primary secret store. It can't be used in request payloads if <code>ref</code> is defined.</p>
</li>
</ul>
secrets (optional)
map[String, Object] Secrets section of the data set. Sensitive information is stored in the primary organization secret store and replaced with the secret store paths when sent outside. Can't be used together with <code>secret_refs</code>.
values (optional)
ValuesSecretsRefs stores data that should be passed around split by sensitivity.
secret_refs (optional)
map[String, Object] <p>Secrets section of the data set. They can hold sensitive information that will be stored in the primary organization secret store and replaced with the secret store paths when sent outside, or secret references stored in a defined secret store. Can't be used together with <code>secrets</code>.</p>
<p>They can hold a nested structure but leaf objects need to be of type SecretReference, where:</p>
<ul>
<li>
<p><code>store</code> is a Secret Store id. It can't be <code>humanitec</code>. It's mandatory if <code>ref</code> is defined and can't be used in request payloads if <code>value</code> is defined.</p>
</li>
<li>
<p><code>ref</code> is the secret key in the format of the target store. It can't be used in request payloads if <code>value</code> is defined.</p>
</li>
<li>
<p><code>version</code> is the version of the secret as defined in the target store. It can be defined only if <code>ref</code> is defined.</p>
</li>
<li>
<p><code>value</code> is the value to store in the organizations primary secret store. It can't be used in request payloads if <code>ref</code> is defined.</p>
</li>
</ul>
secrets (optional)
map[String, Object] Secrets section of the data set. Sensitive information is stored in the primary organization secret store and replaced with the secret store paths when sent outside. Can't be used together with <code>secret_refs</code>.
values (optional)
Credentials to authenticate Vault.
role (optional)
token (optional)
Vault specification.
agent_id (optional)
auth (optional)
path (optional)
url (optional)
Vault specification.
agent_id (optional)
path (optional)
url (optional)
Webhook is a special type of a Job. It performs an HTTPS request to a specified URL with specified headers.
disabled (optional)
Boolean Defines whether this job is currently disabled.
headers (optional)
id (optional)
String Job ID, unique within the Organization
payload (optional)
triggers (optional)
url (optional)
String The webhook's URL (without protocol, only HTTPS is supported).
Webhook is a special type of a Job. It performs an HTTPS request to a specified URL with specified headers.
created_at (optional)
String The timestamp of when this Job was created.
example: 2020-06-22T09:37:23.523Z
created_by (optional)
String The user who created this Job
disabled
Boolean Defines whether this job is currently disabled.
headers
id
String Job ID, unique within the Organization
payload
triggers
url
String The webhook's URL (without protocol, only HTTPS is supported).
Webhook is a special type of a Job. It performs an HTTPS request to a specified URL with specified headers.
disabled
Boolean Defines whether this job is currently disabled.
headers
payload
triggers
url
String The webhook's URL (without protocol, only HTTPS is supported)
References a workload profile chart.
id
String Workload Profile Chart ID
version
Each Workload Profile Chart has one or more Versions associated with it.
created_at
Date Creation date format: date-time
example: 2020-06-22T09:37:23.523Z
created_by
String User created the profile
org_id
id
String Workload Profile Chart Version ID
version
<p>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 <code>schedules</code> used in Kubernetes CronJobs or <code>ingress</code> which might be used to expose Pods controlled by a Kubernetes Deployment.</p>
<p>Workloads in Humanitec are implemented as Helm Charts which must implement a specific schema.</p>
<p>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 <code>schedules</code> used in Kubernetes CronJobs or <code>ingress</code> which might be used to expose Pods controlled by a Kubernetes Deployment.</p>
<p>Workloads in Humanitec are implemented as Helm Charts which must implement a specific schema.</p>
created_at
Date Creation date format: date-time
example: 2020-06-22T09:37:23.523Z
created_by
String User created the profile
id
latest
String The latest version of the profile
org_id
Each Workload Profile has one or more Versions associated with it. In order to add a version, a Workload Profile must first be created.
features (optional)
map[String, Object] <p>A map of Features. If referencing built in Humanitec features, the fully qualified feature name must be used: e.g. <code>humanitec/annotations</code>.</p>
<p>{</p>
<p>}</p>
notes (optional)
spec_definition (optional)
version
workload_profile_chart
Each Workload Profile has one or more Versions associated with it. In order to add a version, a Workload Profile must first be created.
created_at
Date Creation date format: date-time
example: 2020-06-22T09:37:23.523Z
created_by
String User created the profile
features
map[String, Object] <p>A map of Features. If referencing built in Humanitec features, the fully qualified feature name must be used: e.g. <code>humanitec/annotations</code>.</p>
<p>{</p>
<p>}</p>
spec_schema
OpenAPI schema used to validate the spec.
spec_definition (optional)
notes
org_id
profile_id
version
workload_profile_chart
properties (optional)
runtime_properties (optional)
type
feature_name (optional)
title (optional)
version (optional)
ui_hints (optional)
schema (optional)
runtime_properties (optional)
properties (optional)
order (optional)
hidden (optional)
type
feature_name (optional)
title (optional)
version (optional)
ui_hints (optional)