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

Humanitec AutomationRule API

An Automation Rule defining how and when artefacts in an environment should be updated.

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

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

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

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

5 operations 2 paths 4 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Paths & Operations 5

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

AutomationRule 5

An Automation Rule defining how and when artefacts in an environment should be updated.

GET
/orgs/{orgId}/apps/{appId}/envs/{envId}/rules
List all Automation Rules in an Environment.
listAutomationRules 3 params → 200
POST
/orgs/{orgId}/apps/{appId}/envs/{envId}/rules
Create a new Automation Rule for an Environment.
createAutomationRule 3 params body → 201400409422
GET
/orgs/{orgId}/apps/{appId}/envs/{envId}/rules/{ruleId}
Get a specific Automation Rule for an Environment.
getAutomationRule 4 params → 200404
PUT
/orgs/{orgId}/apps/{appId}/envs/{envId}/rules/{ruleId}
Update an existing Automation Rule for an Environment.
updateAutomationRule 4 params body → 200400404422
DELETE
/orgs/{orgId}/apps/{appId}/envs/{envId}/rules/{ruleId}
Delete Automation Rule from an Environment.
deleteAutomationRule 4 params → 204404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are AutomationRuleResponse (12 properties), AutomationRuleRequest (9 properties), ErrorResponse (3 properties), HumanitecErrorResponse (3 properties). Each schema is shown below with its type and property counts.

AutomationRuleResponse
object
An Automation Rule defining how and when artefacts in an environment should be updated.
12 properties 12 required
HumanitecErrorResponse
object
HumanitecError represents a standard Humanitec Error
3 properties 2 required
ErrorResponse
object
A standard error response
3 properties 2 required
AutomationRuleRequest
object
An Automation Rule defining how and when artefacts in an environment should be updated.
9 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

humanitec-automationrule-api-openapi.yml Raw ↑

Other APIs Humanitec publishes across the network.

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