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 MatchingCriteria API

Matching Criteria are a set of rules used to choose which Resource Definition to use to provision a particular Resource Type.Matching criteria are made up in order of specificity with least specific first:- Environment Type (`env_type`)- Application (`app_id`)- Environment (`env_id`)- Resource (`res_id`)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.**NOTE:**Humanitec will reject the registration of matching criteria rules that duplicate rules already present for a Resource Type.

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

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

This API exposes 3 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/.

3 operations 2 paths 4 schemas 1 DELETE1 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 3

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

MatchingCriteria 3

Matching Criteria are a set of rules used to choose which Resource Definition to use to provision a particular Resource Type. Matching criteria are made up in order of specificity…

PUT
/orgs/{orgId}/resources/defs/{defId}/criteria
Update all Matching Criteria of a Resource Definition.
updateResourceDefinitionCriteria 2 params body → 200400404409500
POST
/orgs/{orgId}/resources/defs/{defId}/criteria
Add a new Matching Criteria to a Resource Definition.
createResourceDefinitionCriteria 2 params body → 200400404409500
DELETE
/orgs/{orgId}/resources/defs/{defId}/criteria/{criteriaId}
Delete a Matching Criteria from a Resource Definition.
deleteResourceDefinitionCriteria 4 params → 204404409500

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are MatchingCriteriaResponse (6 properties), MatchingCriteriaRuleRequest (5 properties), ResourceDefinitionChangeResponse (5 properties), HumanitecErrorResponse (3 properties). Each schema is shown below with its type and property counts.

MatchingCriteriaResponse
object
Matching Criteria are a set of rules used to choose which Resource Definition to use to provision a particular Resource Type. Matching criteria are made up in…
6 properties 2 required
HumanitecErrorResponse
object
HumanitecError represents a standard Humanitec Error
3 properties 2 required
ResourceDefinitionChangeResponse
object
ResourceDefinitionChange describes the effects of a Resource Definition or Matching Criteria update/deletion.
5 properties 5 required
MatchingCriteriaRuleRequest
object
MatchingCriteriaRule describes Matching Criteria rules.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

humanitec-matchingcriteria-api-openapi.yml Raw ↑

Other APIs Humanitec publishes across the network.

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