Digital Ocean · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DigitalOcean Security API

11 actions 11 updates phrasing extends openapi/digital-ocean-security-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Digital Ocean's API. It is a proposal applied on top of the contract, not a document Digital Ocean publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 11

$.info
$.paths['/v2/security/scans'].get
$.paths['/v2/security/scans'].post
$.paths['/v2/security/scans/{scan_id}'].get
$.paths['/v2/security/scans/latest'].get
$.paths['/v2/security/scans/rules'].post
$.paths['/v2/security/scans/{scan_id}/findings/{finding_uuid}/affected_resources'].get
$.paths['/v2/security/settings'].get
$.paths['/v2/security/settings/plan'].put
$.paths['/v2/security/settings/suppressions'].post
$.paths['/v2/security/settings/suppressions/{suppression_uuid}'].delete

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 DigitalOcean Security API
  version: 1.0.0
extends: openapi/digital-ocean-security-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-11-18'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/v2/security/scans'].get
  update:
    x-apievangelist-phrasing:
      intent: List security scans
      effect: read
      questions:
      - What security scans have been run on my account?
      - Can I see all security scans in one list?
      instructions:
      - text: List all security scans.
      - text: Show every security scan run on my account.
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/security/scans'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a security scan
      effect: write
      questions:
      - How do I kick off a new security scan?
      - Can I start a security scan on demand?
      instructions:
      - text: Create a new security scan.
      - text: Start a fresh security scan now.
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/security/scans/{scan_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a security scan
      effect: read
      questions:
      - What did one specific security scan find?
      - Can I look up a single scan by its ID?
      instructions:
      - text: Show security scan {scan_id}.
        slots:
          scan_id: path.scan_id
      - text: Get the results of scan {scan_id}.
        slots:
          scan_id: path.scan_id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/security/scans/latest'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the latest security scan
      effect: read
      questions:
      - What was the most recent security scan?
      - Can I see only the latest scan result?
      instructions:
      - text: Show the latest security scan.
      - text: Get the newest security scan result.
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/security/scans/rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a security scan rule
      effect: write
      questions:
      - How do I create a rule that a security scan must follow?
      - Can I add a new security scan rule?
      instructions:
      - text: Create a security scan rule.
      - text: Add a new rule for security scans.
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/security/scans/{scan_id}/findings/{finding_uuid}/affected_resources'].get
  update:
    x-apievangelist-phrasing:
      intent: List resources affected by a finding
      effect: read
      questions:
      - Which resources are affected by a particular security finding?
      - Can I see what a finding hit in a scan?
      instructions:
      - text: Show the affected resources for finding {finding_uuid} in scan {scan_id}.
        slots:
          finding_uuid: path.finding_uuid
          scan_id: path.scan_id
      - text: List resources hit by finding {finding_uuid} from scan {scan_id}.
        slots:
          finding_uuid: path.finding_uuid
          scan_id: path.scan_id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/security/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get security settings
      effect: read
      questions:
      - What security settings are configured on my account?
      - Can I view the current security plan and settings?
      instructions:
      - text: Show my security settings.
      - text: Get the current security plan and settings.
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/security/settings/plan'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace the security settings plan
      effect: write
      questions:
      - How do I change the security plan settings?
      - Can I replace the security settings plan entirely?
      instructions:
      - text: Replace my security settings plan.
      - text: Set a new security plan.
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/security/settings/suppressions'].post
  update:
    x-apievangelist-phrasing:
      intent: Suppress a security finding
      effect: write
      questions:
      - How do I suppress a security finding so it stops showing up?
      - Can I create a suppression for a finding?
      instructions:
      - text: Create a suppression for this security finding.
      - text: Suppress a finding so it stops appearing in scans.
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/security/settings/suppressions/{suppression_uuid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a security suppression
      effect: destructive
      questions:
      - How do I lift a suppression on a security finding?
      - Can I delete a suppression by its UUID?
      instructions:
      - text: Delete suppression {suppression_uuid}.
        slots:
          suppression_uuid: path.suppression_uuid
      - text: Remove the suppression with UUID {suppression_uuid}.
        slots:
          suppression_uuid: path.suppression_uuid
      method: generated
      generated: '2026-11-18'

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.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/digital-ocean-security-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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.