Harness · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Harness Environment API
6 actions
6 updates
phrasing
extends
openapi/harness-environment-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Harness's API. It is a proposal applied on top of the contract, not a document Harness publishes.
What the actions change
x-apievangelist-phrasing
Targets 6
$.info
$.paths['/v1/idp-environments'].post
$.paths['/v1/idp-environments/{environment-id}'].put
$.paths['/v1/idp-environments/{environment-id}'].delete
$.paths['/api/environments/compile'].post
$.paths['/api/environments/schemas'].get
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Harness Environment API
version: 1.0.0
extends: openapi/harness-environment-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 5
- target: $.paths['/v1/idp-environments'].post
update:
x-apievangelist-phrasing:
intent: Create, compile and run an IDP environment
effect: write
questions:
- How do I spin up a new developer environment from an environment blueprint?
- Can I dry-run creating an environment before it actually executes?
instructions:
- text: Create environment {name} (id {id}) owned by {owner} from blueprint {blueprint} version {version} with overrides {overrides}.
slots:
name: requestBody.environment_name
id: requestBody.environment_identifier
owner: requestBody.owner
blueprint: requestBody.environment_blueprint_identifier
version: requestBody.environment_blueprint_version
overrides: requestBody.overrides
- text: Dry-run a new environment from blueprint {environment_blueprint_identifier} with dryRun {dryRun}.
slots:
environment_blueprint_identifier: requestBody.environment_blueprint_identifier
dryRun: query.dryRun
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/idp-environments/{environment-id}'].put
update:
x-apievangelist-phrasing:
intent: Update and re-run an IDP environment
effect: write
questions:
- How do I move an existing environment to a newer blueprint version?
- Can I change an environment's target state and have it recompile and execute?
instructions:
- text: Update environment {environment_id} to blueprint version {environment_blueprint_version}.
slots:
environment_id: path.environment-id
environment_blueprint_version: requestBody.environment_blueprint_version
- text: Set target state {target_state} on existing environment {environment_id} and re-execute it.
slots:
target_state: requestBody.target_state
environment_id: path.environment-id
method: generated
generated: '2026-09-26'
- target: $.paths['/v1/idp-environments/{environment-id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an IDP environment
effect: destructive
questions:
- How do I tear down a developer environment that's no longer active?
- Can I delete an environment within a specific project?
instructions:
- text: Delete environment {environment_id}.
slots:
environment_id: path.environment-id
- text: Remove inactive environment {environment_id} from project {projectIdentifier}.
slots:
environment_id: path.environment-id
projectIdentifier: query.projectIdentifier
method: generated
generated: '2026-09-26'
- target: $.paths['/api/environments/compile'].post
update:
x-apievangelist-phrasing:
intent: Compile an environment to infrastructure
effect: read
questions:
- What infrastructure would my environment YAML compile to for a given target state?
- Can I validate an environment definition without creating it?
instructions:
- text: Compile environment YAML {environmentYaml} for target state {targetState}.
slots:
environmentYaml: requestBody.environmentYaml
targetState: requestBody.targetState
- text: Check that {environmentYaml} compiles to valid infrastructure in project {projectIdentifier} at state {targetState}.
slots:
environmentYaml: requestBody.environmentYaml
projectIdentifier: requestBody.projectIdentifier
targetState: requestBody.targetState
method: generated
generated: '2026-09-26'
- target: $.paths['/api/environments/schemas'].get
update:
x-apievangelist-phrasing:
intent: Get environment and blueprint schemas
effect: read
questions:
- Where can I find the schema for writing environment and blueprint YAML?
- What fields does an environment blueprint definition accept?
instructions:
- text: Get the environment and blueprint schemas for account {account}.
slots:
account: header.Harness-Account
- text: Show the environment blueprint schema for project {projectIdentifier}.
slots:
projectIdentifier: requestBody.projectIdentifier
method: generated
generated: '2026-09-26'
Work with this as data
Every overlay here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for openapi overlays
4 MCP tools reach this
find_overlaysBrowse and filter every overlay in the catalog.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/harness-environment-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.