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.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for DigitalOcean Block Storage Actions API
version: 1.0.0
extends: openapi/digital-ocean-block-storage-actions-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: 4
- target: $.paths['/v2/volumes/actions'].post
update:
x-apievangelist-phrasing:
intent: Attach a block storage volume by name
effect: write
questions:
- Can I attach a block storage volume to a Droplet when I only know the volume's name?
- Which details do I need to give to attach a volume by name, such as the region and Droplet ID?
instructions:
- text: Attach a block storage volume to a Droplet, identifying the volume by its name rather than its ID.
- text: Start a volume action using the volume name and region, with no volume ID.
method: generated
generated: '2026-11-18'
- target: $.paths['/v2/volumes/{volume_id}/actions'].get
update:
x-apievangelist-phrasing:
intent: List actions on a volume
effect: read
questions:
- What actions have been run on a block storage volume?
- Can I see the history of volume actions for one volume?
instructions:
- text: List all actions on volume {volume_id}.
slots:
volume_id: path.volume_id
- text: Show the action history for block storage volume {volume_id}.
slots:
volume_id: path.volume_id
method: generated
generated: '2026-11-18'
- target: $.paths['/v2/volumes/{volume_id}/actions'].post
update:
x-apievangelist-phrasing:
intent: Attach a block storage volume by ID
effect: write
questions:
- How do I attach a block storage volume to a Droplet using the volume's ID?
- Is there a limit to how many volumes can be attached to one Droplet by volume ID?
instructions:
- text: Attach the block storage volume with ID {volume_id} to a Droplet.
slots:
volume_id: path.volume_id
- text: Start an action on the volume with ID {volume_id}, addressing it by ID instead of by name.
slots:
volume_id: path.volume_id
method: generated
generated: '2026-11-18'
- target: $.paths['/v2/volumes/{volume_id}/actions/{action_id}'].get
update:
x-apievangelist-phrasing:
intent: Check a volume action
effect: read
questions:
- Has a volume attachment action finished?
- Can I check the status of one action on a volume?
instructions:
- text: Get action {action_id} on volume {volume_id}.
slots:
action_id: path.action_id
volume_id: path.volume_id
- text: Check whether volume {volume_id} action {action_id} succeeded.
slots:
volume_id: path.volume_id
action_id: path.action_id
method: generated
generated: '2026-11-18'
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.