Palo Alto Networks · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for TLS Protect Cloud API for Strata Cloud Manager Machine…

8 actions 8 updates phrasing extends openapi/palo-alto-networks-machine-installations-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Palo Alto Networks's API. It is a proposal applied on top of the contract, not a document Palo Alto Networks publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info

$.paths['/v1/machineidentities'].get

$.paths['/v1/machineidentities'].post

$.paths['/v1/machineidentities/{id}'].get

$.paths['/v1/machineidentities/{id}'].delete

$.paths['/v1/machineidentities/{id}'].patch

$.paths['/v1/machineidentities/{id}/workflows'].post

$.paths['/v1/machineidentitysearch'].post

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 TLS Protect Cloud API for Strata Cloud Manager Machine…
  version: 1.0.0
extends: openapi/palo-alto-networks-machine-installations-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: 7
- target: $.paths['/v1/machineidentities'].get
  update:
    x-apievangelist-phrasing:
      intent: List all machine identities
      effect: read
      questions:
      - Which machine identities are installed across my machines?
      - Can I see every certificate installation on my machines at once?
      instructions:
      - text: List all machine identities.
      - text: Show every certificate installed on my machines.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/machineidentities'].post
  update:
    x-apievangelist-phrasing:
      intent: Install a certificate on a machine
      effect: write
      questions:
      - How do I add a machine identity that binds a certificate to a machine?
      - Can I specify a keystore when adding a machine identity?
      instructions:
      - text: Add certificate {certificateId} as a machine identity on machine {machineId}.
        slots:
          certificateId: requestBody.certificateId
          machineId: requestBody.machineId
      - text: Install certificate {certificateId} on machine {machineId} using keystore {keystore}.
        slots:
          certificateId: requestBody.certificateId
          machineId: requestBody.machineId
          keystore: requestBody.keystore
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/machineidentities/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a machine identity
      effect: read
      questions:
      - What certificate and binding does a particular machine identity have?
      - Can I look up one machine identity by its ID?
      instructions:
      - text: Get machine identity {id}.
        slots:
          id: path.id
      - text: Show details of machine identity {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/machineidentities/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a machine identity
      effect: destructive
      questions:
      - How do I remove a machine identity I no longer need?
      - Is deleting a machine identity reversible?
      instructions:
      - text: Delete machine identity {id}.
        slots:
          id: path.id
      - text: Remove the obsolete machine identity {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/machineidentities/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a machine identity
      effect: write
      questions:
      - Can I swap the certificate on an existing machine identity?
      - Which fields of a machine identity can be patched?
      instructions:
      - text: Point machine identity {id} at certificate {certificateId}.
        slots:
          id: path.id
          certificateId: requestBody.certificateId
      - text: Change the binding of machine identity {id} to {binding}.
        slots:
          id: path.id
          binding: requestBody.binding
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/machineidentities/{id}/workflows'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a workflow on a machine identity
      effect: write
      questions:
      - Can I test the connection for a machine identity?
      - What workflows can I kick off against a machine identity?
      instructions:
      - text: Run workflow {workflowName} on machine identity {id}.
        slots:
          workflowName: requestBody.workflowName
          id: path.id
      - text: Start testConnection on machine identity {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/machineidentitysearch'].post
  update:
    x-apievangelist-phrasing:
      intent: Search machine identities by expression
      effect: read
      questions:
      - How do I search machine identities with a filter expression?
      - Can machine identity search results be ordered and paged?
      instructions:
      - text: Search machine identities matching expression {expression}.
        slots:
          expression: requestBody.expression
      - text: Find machine identities with expression {expression}, ordered by {ordering}.
        slots:
          expression: requestBody.expression
          ordering: requestBody.ordering
      method: generated
      generated: '2026-09-26'