Skip to content

Latest commit

 

History

History
88 lines (77 loc) · 7.29 KB

commands.md

File metadata and controls

88 lines (77 loc) · 7.29 KB

Command reference

Generated by scripts/check-coverage.py from the checked-in contracts and the command mapping; do not edit by hand.

Login, credentials, and profiles

These commands use the auth service (https://auth.voltage.cloud/api/v1, overridable with --auth-url) or only local state.

Command Routes
voltage login POST /api/v1/oauth/device_authorization
POST /api/v1/oauth/token
GET /api/v1/users/current
voltage logout POST /api/v1/oauth/revoke
voltage auth status local only
voltage auth import-key local only
voltage organizations list GET /api/v1/users/current
voltage environments list POST /api/v1/oauth/token
GET /api/v1/organizations/{organization_id}/environments
voltage context local only
voltage profiles create NAME local only
voltage profiles get NAME local only
voltage profiles list local only
voltage profiles delete NAME local only
voltage completions SHELL local only
  • Every organization API call first exchanges the saved login for an organization token with POST /api/v1/oauth/token, and an expiring login is refreshed there as well.
  • A failed login revokes its new session with POST /api/v1/oauth/revoke so nothing is left running on the server.

Prices

These commands use the coinprice service (https://coinprice.voltage.cloud, overridable with --price-url) and need no credentials.

Command Routes
voltage price GET /currency/{pair}/{time}
voltage convert AMOUNT UNIT --to CURRENCY GET /currency/{pair}/{time}

API operations

IDs are positional, or passed as --id ID; enclosing scope uses flags. Paths are relative to the API base URL (https://voltageapi.com/v1, overridable with --api-url).

Command Method Path
voltage assets list GET /organizations/{organization_id}/assets
voltage wallets list GET /organizations/{organization_id}/wallets
voltage wallets create POST /organizations/{organization_id}/wallets
voltage wallets get WALLET_ID GET /organizations/{organization_id}/wallets/{wallet_id}
voltage wallets delete WALLET_ID DELETE /organizations/{organization_id}/wallets/{wallet_id}
voltage wallets update WALLET_ID PATCH /organizations/{organization_id}/wallets/{wallet_id}
voltage wallets ledger list WALLET_ID GET /organizations/{organization_id}/wallets/{wallet_id}/ledger
voltage wallets policies get WALLET_ID GET /organizations/{organization_id}/wallets/{wallet_id}/policies
voltage wallets policies update WALLET_ID PATCH /organizations/{organization_id}/wallets/{wallet_id}/policies
voltage payments list GET /organizations/{organization_id}/environments/{environment_id}/payments
voltage payments create POST /organizations/{organization_id}/environments/{environment_id}/payments
voltage treasury movements create POST /organizations/{organization_id}/environments/{environment_id}/treasury_movements
voltage payments check POST /organizations/{organization_id}/environments/{environment_id}/payments/check
voltage payments summary GET /organizations/{organization_id}/environments/{environment_id}/payments/summary
voltage wallets payments summary WALLET_ID GET /organizations/{organization_id}/wallets/{wallet_id}/payments/summary
voltage payments get PAYMENT_ID GET /organizations/{organization_id}/environments/{environment_id}/payments/{payment_id}
voltage payments history PAYMENT_ID GET /organizations/{organization_id}/environments/{environment_id}/payments/{payment_id}/history
voltage credit-lines update-sandbox LINE_ID PATCH /organizations/{organization_id}/environments/{environment_id}/lines_of_credit/{line_id}/sandbox
voltage credit-lines get LINE_ID GET /organizations/{organization_id}/lines_of_credit/{line_id}/summary
voltage credit-lines list GET /organizations/{organization_id}/lines_of_credit/summaries
voltage bills get BILL_ID GET /organizations/{organization_id}/bills/{bill_id}
voltage bills list GET /organizations/{organization_id}/bills
voltage bills summary GET /organizations/{organization_id}/bills/summary
voltage webhooks list GET /organizations/{organization_id}/webhooks
voltage webhooks create POST /organizations/{organization_id}/environments/{environment_id}/webhooks
voltage webhooks get WEBHOOK_ID GET /organizations/{organization_id}/environments/{environment_id}/webhooks/{webhook_id}
voltage webhooks delete WEBHOOK_ID DELETE /organizations/{organization_id}/environments/{environment_id}/webhooks/{webhook_id}
voltage webhooks update WEBHOOK_ID PATCH /organizations/{organization_id}/environments/{environment_id}/webhooks/{webhook_id}
voltage webhooks keys rotate WEBHOOK_ID POST /organizations/{organization_id}/environments/{environment_id}/webhooks/{webhook_id}/keys
voltage webhooks test WEBHOOK_ID POST /organizations/{organization_id}/environments/{environment_id}/webhooks/{webhook_id}/test
voltage webhooks start WEBHOOK_ID POST /organizations/{organization_id}/environments/{environment_id}/webhooks/{webhook_id}/start
voltage webhooks stop WEBHOOK_ID POST /organizations/{organization_id}/environments/{environment_id}/webhooks/{webhook_id}/stop
voltage webhooks deliveries list GET /organizations/{organization_id}/environments/{environment_id}/webhooks/{webhook_id}/deliveries
voltage webhooks deliveries summary GET /organizations/{organization_id}/environments/{environment_id}/webhooks/{webhook_id}/deliveries/summary
voltage webhooks deliveries get DELIVERY_ID GET /organizations/{organization_id}/environments/{environment_id}/webhooks/{webhook_id}/deliveries/{delivery_id}
voltage webhooks deliveries abandon DELIVERY_ID POST /organizations/{organization_id}/environments/{environment_id}/webhooks/{webhook_id}/deliveries/{delivery_id}/abandon
voltage webhooks deliveries retry DELIVERY_ID POST /organizations/{organization_id}/environments/{environment_id}/webhooks/{webhook_id}/deliveries/{delivery_id}/retry
voltage quotes list GET /organizations/{organization_id}/environments/{environment_id}/quotes
voltage quotes create POST /organizations/{organization_id}/environments/{environment_id}/quotes
voltage quotes get QUOTE_ID GET /organizations/{organization_id}/environments/{environment_id}/quotes/{quote_id}
voltage checkout events watch GET /checkout/events
voltage checkout streams create POST /checkout/streams
voltage checkout settings get GET /organizations/{organization_id}/environments/{environment_id}/checkout/settings
voltage checkout settings update PUT /organizations/{organization_id}/environments/{environment_id}/checkout/settings
voltage checkout sessions create POST /organizations/{organization_id}/environments/{environment_id}/checkout/sessions
voltage checkout sessions get SESSION_ID GET /checkout/sessions/{session_id}
voltage checkout sessions allowed-origins SESSION_ID GET /checkout/sessions/{session_id}/allowed-origins