Harness · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Harness Agent mTLS Endpoint Management API

7 actions 7 updates phrasing extends openapi/harness-agent-mtls-endpoint-management-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.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/ng/api/agent/mtls/endpoint'].get
$.paths['/ng/api/agent/mtls/endpoint'].put
$.paths['/ng/api/agent/mtls/endpoint'].post
$.paths['/ng/api/agent/mtls/endpoint'].delete
$.paths['/ng/api/agent/mtls/endpoint'].patch
$.paths['/ng/api/agent/mtls/check-availability'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Harness Agent mTLS Endpoint Management API
  version: 1.0.0
extends: openapi/harness-agent-mtls-endpoint-management-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: 6
- target: $.paths['/ng/api/agent/mtls/endpoint'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the account's agent mTLS endpoint
      effect: read
      questions:
      - What mTLS endpoint do my delegates use to connect to Harness?
      - Which domain prefix and mode is my agent mTLS endpoint configured with?
      instructions:
      - text: Get the agent mTLS endpoint for account {account}.
        slots:
          account: query.accountIdentifier
      - text: Show the current mTLS endpoint configuration for my account.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/agent/mtls/endpoint'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace the agent mTLS endpoint configuration
      effect: write
      questions:
      - How do I replace the whole agent mTLS endpoint config with new CA certificates and mode?
      - Can I change the domain prefix of an existing mTLS endpoint?
      instructions:
      - text: Replace the mTLS endpoint for account {account} with prefix {prefix}, CA certs {certs} and mode {mode}.
        slots:
          account: query.accountIdentifier
          prefix: requestBody.domainPrefix
          certs: requestBody.caCertificates
          mode: requestBody.mode
      - text: Fully update the agent mTLS endpoint for account {account}.
        slots:
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/agent/mtls/endpoint'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an agent mTLS endpoint
      effect: write
      questions:
      - How do I set up mutual TLS for delegate connections to my Harness account?
      - What do I need to provide to create an agent mTLS endpoint?
      instructions:
      - text: Create an agent mTLS endpoint for account {account} with domain prefix {prefix}.
        slots:
          account: query.accountIdentifier
          prefix: requestBody.domainPrefix
      - text: Set up a new mTLS endpoint using CA certificates {certs} in {mode} mode.
        slots:
          certs: requestBody.caCertificates
          mode: requestBody.mode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/agent/mtls/endpoint'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove the agent mTLS endpoint
      effect: destructive
      questions:
      - How do I turn off mutual TLS for delegates by deleting the endpoint?
      - Can I remove my account's agent mTLS endpoint entirely?
      instructions:
      - text: Delete the agent mTLS endpoint for account {account}.
        slots:
          account: query.accountIdentifier
      - text: Remove mutual TLS endpoint from my account {account}.
        slots:
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/agent/mtls/endpoint'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change selected mTLS endpoint settings
      effect: write
      questions:
      - Can I switch just the enforcement mode of my mTLS endpoint without resending the certificates?
      - How do I rotate only the CA certificates on the agent mTLS endpoint?
      instructions:
      - text: Change only the mTLS endpoint mode to {mode} for account {account}.
        slots:
          mode: requestBody.mode
          account: query.accountIdentifier
      - text: Patch just the CA certificates to {certs} on the mTLS endpoint for account {account}.
        slots:
          certs: requestBody.caCertificates
          account: query.accountIdentifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ng/api/agent/mtls/check-availability'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if an mTLS domain prefix is available
      effect: read
      questions:
      - Is the domain prefix I want for my agent mTLS endpoint already taken?
      - Can I check prefix availability before creating the mTLS endpoint?
      instructions:
      - text: Check whether domain prefix {prefix} is available for account {account}.
        slots:
          prefix: query.domainPrefix
          account: query.accountIdentifier
      - text: See if {prefix} can be used as my mTLS endpoint prefix.
        slots:
          prefix: query.domainPrefix
      method: generated
      generated: '2026-09-26'