# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for Snyk Cloud API version: 1.0.0 extends: openapi/snyk-cloud-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: 9 - target: $.paths['/orgs/{org_id}/cloud/environments'].get update: x-apievangelist-phrasing: intent: List cloud environments for an organization effect: read questions: - Which cloud environments has my Snyk org connected? - Can I filter cloud environments by kind, status or name? - What environments were created in the last month? instructions: - text: List cloud environments in org {org_id}. slots: org_id: path.org_id - text: Show {kind} environments in org {org_id} with status {status}. slots: kind: query.kind org_id: path.org_id status: query.status - text: Find environments named {name} in org {org_id}. slots: name: query.name org_id: path.org_id method: generated generated: '2026-09-26' - target: $.paths['/orgs/{org_id}/cloud/environments'].post update: x-apievangelist-phrasing: intent: Connect a new cloud environment and scan it effect: write questions: - How do I connect a cloud account to Snyk as a new environment? - Does adding a cloud environment kick off a scan straight away? instructions: - text: Create a new cloud environment in org {org_id}. slots: org_id: path.org_id - text: Onboard my cloud account as an environment in org {org_id} and scan it. slots: org_id: path.org_id method: generated generated: '2026-09-26' - target: $.paths['/orgs/{org_id}/cloud/environments/{environment_id}'].delete update: x-apievangelist-phrasing: intent: Delete a cloud environment effect: destructive questions: - How do I disconnect a cloud environment from Snyk? - Can I remove an environment I no longer want scanned? instructions: - text: Delete cloud environment {environment_id} from org {org_id}. slots: environment_id: path.environment_id org_id: path.org_id - text: Remove environment {environment_id} in organization {org_id}. slots: environment_id: path.environment_id org_id: path.org_id method: generated generated: '2026-09-26' - target: $.paths['/orgs/{org_id}/cloud/environments/{environment_id}'].patch update: x-apievangelist-phrasing: intent: Update a cloud environment effect: write questions: - How do I edit the settings of a connected cloud environment? - Can I rename an existing environment? instructions: - text: Update cloud environment {environment_id} in org {org_id}. slots: environment_id: path.environment_id org_id: path.org_id - text: Change the settings of environment {environment_id} for organization {org_id}. slots: environment_id: path.environment_id org_id: path.org_id method: generated generated: '2026-09-26' - target: $.paths['/orgs/{org_id}/cloud/permissions'].post update: x-apievangelist-phrasing: intent: Generate the IaC template granting Snyk cloud access effect: read questions: - What permissions does Snyk need in my cloud account, and can it give me a template? - How do I get the IAC template that lets Snyk read my cloud resources? instructions: - text: Generate the cloud provider permissions template for org {org_id}. slots: org_id: path.org_id - text: Produce the access template Snyk needs before I connect a cloud account to org {org_id}. slots: org_id: path.org_id method: generated generated: '2026-09-26' - target: $.paths['/orgs/{org_id}/cloud/resources'].get update: x-apievangelist-phrasing: intent: List cloud resources Snyk has discovered effect: read questions: - What cloud resources has Snyk found in my environments? - Can I filter resources by type, location or platform? - Which resources have been removed from my cloud? instructions: - text: List cloud resources in org {org_id}. slots: org_id: path.org_id - text: Show {resource_type} resources in environment {environment_id} for org {org_id}. slots: resource_type: query.resource_type environment_id: query.environment_id org_id: path.org_id - text: Find resources in {location} for org {org_id}. slots: location: query.location org_id: path.org_id method: generated generated: '2026-09-26' - target: $.paths['/orgs/{org_id}/cloud/scans'].get update: x-apievangelist-phrasing: intent: List cloud scans for an organization effect: read questions: - Which cloud scans have run for my organization? - Can I see the history of environment scans? instructions: - text: List cloud scans in org {org_id}. slots: org_id: path.org_id - text: Show the last {limit} cloud scans for org {org_id}. slots: limit: query.limit org_id: path.org_id method: generated generated: '2026-09-26' - target: $.paths['/orgs/{org_id}/cloud/scans'].post update: x-apievangelist-phrasing: intent: Trigger a new scan of a cloud environment effect: write questions: - How do I rescan a cloud environment on demand? - Can I trigger a cloud scan without waiting for the schedule? instructions: - text: Start a new cloud scan in org {org_id}. slots: org_id: path.org_id - text: Trigger a scan of my environment now for organization {org_id}. slots: org_id: path.org_id method: generated generated: '2026-09-26' - target: $.paths['/orgs/{org_id}/cloud/scans/{scan_id}'].get update: x-apievangelist-phrasing: intent: Get a single cloud scan effect: read questions: - What's the status of a particular cloud scan? - Can I look up one scan's details by scan ID? instructions: - text: Get cloud scan {scan_id} in org {org_id}. slots: scan_id: path.scan_id org_id: path.org_id - text: Check the status of scan {scan_id} for organization {org_id}. slots: scan_id: path.scan_id org_id: path.org_id method: generated generated: '2026-09-26'