Digital Ocean · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for DigitalOcean Apps API

39 actions 39 updates phrasing extends openapi/digital-ocean-apps-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 39 · first 16 shown; the file carries all of them

$.info
$.paths['/v2/apps'].get
$.paths['/v2/apps'].post
$.paths['/v2/apps/{id}'].get
$.paths['/v2/apps/{id}'].put
$.paths['/v2/apps/{id}'].delete
$.paths['/v2/apps/{app_id}/restart'].post
$.paths['/v2/apps/{app_id}/components/{component_name}/logs'].get
$.paths['/v2/apps/{app_id}/components/{component_name}/exec'].get
$.paths['/v2/apps/{app_id}/instances'].get
$.paths['/v2/apps/{app_id}/deployments'].get
$.paths['/v2/apps/{app_id}/deployments'].post
$.paths['/v2/apps/{app_id}/deployments/{deployment_id}'].get
$.paths['/v2/apps/{app_id}/deployments/{deployment_id}/cancel'].post
$.paths['/v2/apps/{app_id}/deployments/{deployment_id}/components/{component_name}/logs'].get
$.paths['/v2/apps/{app_id}/deployments/{deployment_id}/logs'].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 DigitalOcean Apps API
  version: 1.0.0
extends: openapi/digital-ocean-apps-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: 38
- target: $.paths['/v2/apps'].get
  update:
    x-apievangelist-phrasing:
      intent: List apps
      effect: read
      questions:
      - Which apps have I deployed on App Platform?
      - Can I see all my apps in one list?
      instructions:
      - text: List all my apps.
      - text: Show every App Platform app I own.
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an app
      effect: write
      questions:
      - How do I deploy a new app to App Platform?
      - Can I create an app from an existing git repo?
      instructions:
      - text: Create a new app.
      - text: Deploy a fresh app to App Platform.
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an app
      effect: read
      questions:
      - What is the status of one of my apps?
      - Can I look up an app by its ID?
      instructions:
      - text: Show app {id}.
        slots:
          id: path.id
      - text: Get the details of app {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an app
      effect: write
      questions:
      - How do I overwrite an app's configuration?
      - Can I replace an entire app definition?
      instructions:
      - text: Replace app {id}.
        slots:
          id: path.id
      - text: Overwrite the whole definition of app {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an app
      effect: destructive
      questions:
      - How do I delete an app I no longer need?
      - Can I remove an app by its ID?
      instructions:
      - text: Delete app {id}.
        slots:
          id: path.id
      - text: Remove the app {id} from App Platform.
        slots:
          id: path.id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/{app_id}/restart'].post
  update:
    x-apievangelist-phrasing:
      intent: Restart an app
      effect: write
      questions:
      - How do I restart an app without redeploying?
      - Can I force an app to restart?
      instructions:
      - text: Restart app {app_id}.
        slots:
          app_id: path.app_id
      - text: Restart every component of app {app_id}.
        slots:
          app_id: path.app_id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/{app_id}/components/{component_name}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get component logs
      effect: read
      questions:
      - Where can I see the logs for one component of an app?
      - Can I read the logs of a single component?
      instructions:
      - text: Show the logs for component {component_name} of app {app_id}.
        slots:
          component_name: path.component_name
          app_id: path.app_id
      - text: Get the output of component {component_name} in app {app_id}.
        slots:
          component_name: path.component_name
          app_id: path.app_id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/{app_id}/components/{component_name}/exec'].get
  update:
    x-apievangelist-phrasing:
      intent: Open a shell to a component
      effect: read
      questions:
      - Can I run a shell command inside one component of an app?
      - How do I open an interactive session with a component?
      instructions:
      - text: Open an exec session to component {component_name} of app {app_id}.
        slots:
          component_name: path.component_name
          app_id: path.app_id
      - text: Run a shell command in component {component_name} of app {app_id}.
        slots:
          component_name: path.component_name
          app_id: path.app_id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/{app_id}/instances'].get
  update:
    x-apievangelist-phrasing:
      intent: List an app's instances
      effect: read
      questions:
      - Which instances is my app running on?
      - Can I see the current instances of an app?
      instructions:
      - text: List the instances of app {app_id}.
        slots:
          app_id: path.app_id
      - text: Show which instances app {app_id} is deployed on.
        slots:
          app_id: path.app_id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/{app_id}/deployments'].get
  update:
    x-apievangelist-phrasing:
      intent: List an app's deployments
      effect: read
      questions:
      - What deployments has my app had?
      - Can I see the deployment history of an app?
      instructions:
      - text: List the deployments of app {app_id}.
        slots:
          app_id: path.app_id
      - text: Show the deployment history for app {app_id}.
        slots:
          app_id: path.app_id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/{app_id}/deployments'].post
  update:
    x-apievangelist-phrasing:
      intent: Deploy an app
      effect: write
      questions:
      - How do I deploy a new version of my app?
      - Can I trigger a new deployment of an app?
      instructions:
      - text: Deploy a new version of app {app_id}.
        slots:
          app_id: path.app_id
      - text: Trigger a fresh deployment for app {app_id}.
        slots:
          app_id: path.app_id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/{app_id}/deployments/{deployment_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an app deployment
      effect: read
      questions:
      - What happened in a specific deployment of my app?
      - Can I inspect one deployment by its ID?
      instructions:
      - text: Show deployment {deployment_id} of app {app_id}.
        slots:
          deployment_id: path.deployment_id
          app_id: path.app_id
      - text: Get the details of deployment {deployment_id} for app {app_id}.
        slots:
          deployment_id: path.deployment_id
          app_id: path.app_id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/{app_id}/deployments/{deployment_id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel an app deployment
      effect: destructive
      questions:
      - How do I cancel a deployment that is still in progress?
      - Can I stop a pending app deployment?
      instructions:
      - text: Cancel deployment {deployment_id} of app {app_id}.
        slots:
          deployment_id: path.deployment_id
          app_id: path.app_id
      - text: Stop the in-progress deployment {deployment_id} for app {app_id}.
        slots:
          deployment_id: path.deployment_id
          app_id: path.app_id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/{app_id}/deployments/{deployment_id}/components/{component_name}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get component logs for a deployment
      effect: read
      questions:
      - Where can I see a component's logs for a specific deployment?
      - Can I read deployment-level logs for one component?
      instructions:
      - text: Show the logs for component {component_name} in deployment {deployment_id} of app {app_id}.
        slots:
          component_name: path.component_name
          deployment_id: path.deployment_id
          app_id: path.app_id
      - text: Get component {component_name} logs from deployment {deployment_id} of app {app_id}.
        slots:
          component_name: path.component_name
          deployment_id: path.deployment_id
          app_id: path.app_id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/{app_id}/deployments/{deployment_id}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get app logs for a deployment
      effect: read
      questions:
      - Can I see the combined logs of an app for a single deployment?
      - Where are the logs for one deployment of my app?
      instructions:
      - text: Show the app logs for deployment {deployment_id} of app {app_id}.
        slots:
          deployment_id: path.deployment_id
          app_id: path.app_id
      - text: Get the combined logs of app {app_id} from deployment {deployment_id}.
        slots:
          app_id: path.app_id
          deployment_id: path.deployment_id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/{app_id}/deployments/{deployment_id}/components/{component_name}/exec'].get
  update:
    x-apievangelist-phrasing:
      intent: Open a shell to a component in a deployment
      effect: read
      questions:
      - Can I run a shell command inside a component of a specific deployment?
      - How do I open an exec session for a deployment's component?
      instructions:
      - text: Open an exec session to component {component_name} in deployment {deployment_id} of app {app_id}.
        slots:
          component_name: path.component_name
          deployment_id: path.deployment_id
          app_id: path.app_id
      - text: Run a shell command in component {component_name} of deployment {deployment_id} for app {app_id}.
        slots:
          component_name: path.component_name
          deployment_id: path.deployment_id
          app_id: path.app_id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/{app_id}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an app's logs
      effect: read
      questions:
      - Where can I see the combined logs of my app in real time?
      - Can I stream an app's logs?
      instructions:
      - text: Show the logs for app {app_id}.
        slots:
          app_id: path.app_id
      - text: Stream the combined logs of app {app_id}.
        slots:
          app_id: path.app_id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/{app_id}/job-invocations'].get
  update:
    x-apievangelist-phrasing:
      intent: List an app's job invocations
      effect: read
      questions:
      - Which jobs have been run on my app?
      - Can I see the job invocation history of an app?
      instructions:
      - text: List the job invocations of app {app_id}.
        slots:
          app_id: path.app_id
      - text: Show the job invocation history for app {app_id}.
        slots:
          app_id: path.app_id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/{app_id}/job-invocations/{job_invocation_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an app job invocation
      effect: read
      questions:
      - What happened in a specific job invocation of my app?
      - Can I inspect one job invocation by its ID?
      instructions:
      - text: Show job invocation {job_invocation_id} of app {app_id}.
        slots:
          job_invocation_id: path.job_invocation_id
          app_id: path.app_id
      - text: Get the details of job invocation {job_invocation_id} for app {app_id}.
        slots:
          job_invocation_id: path.job_invocation_id
          app_id: path.app_id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/{app_id}/job-invocations/{job_invocation_id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel an app job invocation
      effect: destructive
      questions:
      - How do I cancel a job invocation that is still running?
      - Can I stop a pending job on my app?
      instructions:
      - text: Cancel job invocation {job_invocation_id} of app {app_id}.
        slots:
          job_invocation_id: path.job_invocation_id
          app_id: path.app_id
      - text: Stop the in-progress job invocation {job_invocation_id} for app {app_id}.
        slots:
          job_invocation_id: path.job_invocation_id
          app_id: path.app_id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/{app_id}/jobs/{job_name}/invocations/{job_invocation_id}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get logs for a job invocation
      effect: read
      questions:
      - How do I see the logs from a specific invocation of a background job?
      - Can I fetch the output of a single job run?
      instructions:
      - text: Get the logs for invocation {job_invocation_id} of job {job_name} in app {app_id}.
        slots:
          job_invocation_id: path.job_invocation_id
          job_name: path.job_name
          app_id: path.app_id
      - text: Show the output of job {job_name} run {job_invocation_id} in app {app_id}.
        slots:
          job_name: path.job_name
          job_invocation_id: path.job_invocation_id
          app_id: path.app_id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/{app_id}/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List events for an app
      effect: read
      questions:
      - What events have happened on my app recently?
      - Can I see the event history for an app?
      instructions:
      - text: List events for app {app_id}.
        slots:
          app_id: path.app_id
      - text: Show the event history of app {app_id}.
        slots:
          app_id: path.app_id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/{app_id}/events/{event_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an app event
      effect: read
      questions:
      - What happened when a particular event occurred on my app?
      - Can I look up one app event by its ID?
      instructions:
      - text: Get event {event_id} for app {app_id}.
        slots:
          event_id: path.event_id
          app_id: path.app_id
      - text: Show the details of event {event_id} on app {app_id}.
        slots:
          event_id: path.event_id
          app_id: path.app_id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/{app_id}/events/{event_id}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel an app event
      effect: destructive
      questions:
      - How do I cancel an event that's still running on my app?
      - Can I stop an app event partway through?
      instructions:
      - text: Cancel event {event_id} on app {app_id}.
        slots:
          event_id: path.event_id
          app_id: path.app_id
      - text: Stop the running event {event_id} in app {app_id}.
        slots:
          event_id: path.event_id
          app_id: path.app_id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/{app_id}/events/{event_id}/logs'].get
  update:
    x-apievangelist-phrasing:
      intent: Get logs for an app event
      effect: read
      questions:
      - How do I see the logs for an event that happened on my app?
      - Can I fetch the output of an app event?
      instructions:
      - text: Get the logs for event {event_id} in app {app_id}.
        slots:
          event_id: path.event_id
          app_id: path.app_id
      - text: Show the output of event {event_id} on app {app_id}.
        slots:
          event_id: path.event_id
          app_id: path.app_id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/tiers/instance_sizes'].get
  update:
    x-apievangelist-phrasing:
      intent: List app instance sizes
      effect: read
      questions:
      - Which instance sizes can I choose for my app?
      - What instance tiers are available for App Platform?
      instructions:
      - text: List all app instance sizes.
      - text: Show the available App Platform instance tiers.
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/tiers/instance_sizes/{slug}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an app instance size
      effect: read
      questions:
      - What does a particular app instance size include?
      - Can I look up one instance size by its slug?
      instructions:
      - text: Get app instance size {slug}.
        slots:
          slug: path.slug
      - text: Show the details of instance size {slug}.
        slots:
          slug: path.slug
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/regions'].get
  update:
    x-apievangelist-phrasing:
      intent: List app regions
      effect: read
      questions:
      - In which regions can I deploy my app?
      - Which regions support App Platform?
      instructions:
      - text: List the regions where App Platform is available.
      - text: Show every region I can deploy an app to.
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/propose'].post
  update:
    x-apievangelist-phrasing:
      intent: Propose an app deployment
      effect: write
      questions:
      - How do I preview what an app would look like before deploying it?
      - Can I propose an app spec without creating the app?
      instructions:
      - text: Propose an app deployment.
      - text: Preview an app spec before creating the app.
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/{app_id}/alerts'].get
  update:
    x-apievangelist-phrasing:
      intent: List alerts for an app
      effect: read
      questions:
      - What alerts are configured for my app?
      - Can I see the alert rules on an app?
      instructions:
      - text: List alerts for app {app_id}.
        slots:
          app_id: path.app_id
      - text: Show the alert rules on app {app_id}.
        slots:
          app_id: path.app_id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/{app_id}/alerts/{alert_id}/destinations'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a destination to an app alert
      effect: write
      questions:
      - How do I get an app alert sent to a notification destination?
      - Can I add a Slack channel as an alert destination?
      instructions:
      - text: Add a destination to alert {alert_id} on app {app_id}.
        slots:
          alert_id: path.alert_id
          app_id: path.app_id
      - text: Send alert {alert_id} from app {app_id} to a notification destination.
        slots:
          alert_id: path.alert_id
          app_id: path.app_id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/{app_id}/rollback'].post
  update:
    x-apievangelist-phrasing:
      intent: Roll back an app to a previous version
      effect: destructive
      questions:
      - How do I roll my app back to an earlier version?
      - Can I undo a recent app deployment?
      instructions:
      - text: Roll back app {app_id} to its previous version.
        slots:
          app_id: path.app_id
      - text: Undo the latest deployment of app {app_id}.
        slots:
          app_id: path.app_id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/{app_id}/rollback/validate'].post
  update:
    x-apievangelist-phrasing:
      intent: Validate an app rollback
      effect: read
      questions:
      - Can I check what a rollback would change before committing it?
      - Is there a dry run for rolling back an app?
      instructions:
      - text: Validate the rollback of app {app_id}.
        slots:
          app_id: path.app_id
      - text: Dry-run the rollback for app {app_id} without committing it.
        slots:
          app_id: path.app_id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/{app_id}/rollback/commit'].post
  update:
    x-apievangelist-phrasing:
      intent: Commit an app rollback
      effect: destructive
      questions:
      - How do I make a rollback permanent?
      - Can I commit the rollback I validated earlier?
      instructions:
      - text: Commit the rollback of app {app_id}.
        slots:
          app_id: path.app_id
      - text: Make the rollback of app {app_id} permanent.
        slots:
          app_id: path.app_id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/{app_id}/rollback/revert'].post
  update:
    x-apievangelist-phrasing:
      intent: Revert an app rollback
      effect: destructive
      questions:
      - How do I undo a rollback and go back to the current version?
      - Can I reverse a rollback I already committed?
      instructions:
      - text: Revert the rollback of app {app_id}.
        slots:
          app_id: path.app_id
      - text: Undo the rollback on app {app_id} and restore the current version.
        slots:
          app_id: path.app_id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/{app_id}/metrics/bandwidth_daily'].get
  update:
    x-apievangelist-phrasing:
      intent: Get daily bandwidth metrics for an app
      effect: read
      questions:
      - How much bandwidth did my app use each day?
      - Can I see daily bandwidth usage for an app?
      instructions:
      - text: Get daily bandwidth metrics for app {app_id}.
        slots:
          app_id: path.app_id
      - text: Show how much bandwidth app {app_id} used per day.
        slots:
          app_id: path.app_id
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/metrics/bandwidth_daily'].post
  update:
    x-apievangelist-phrasing:
      intent: Report daily bandwidth usage for all apps
      effect: write
      questions:
      - How do I report daily bandwidth usage across all my apps?
      - Can I send daily bandwidth metrics for every app at once?
      instructions:
      - text: Report daily bandwidth usage for all apps.
      - text: Send daily bandwidth metrics for every app in one request.
      method: generated
      generated: '2026-11-18'
- target: $.paths['/v2/apps/{app_id}/health'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an app's health
      effect: read
      questions:
      - Is my app up and running?
      - Can I check the health of an app?
      instructions:
      - text: Check the health of app {app_id}.
        slots:
          app_id: path.app_id
      - text: Tell me whether app {app_id} is healthy.
        slots:
          app_id: path.app_id
      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-apps-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.