ComputeNext REST API

Contents:

• Introduction
  • Concepts
  • API endpoint
  • API Versions
  • Authentication
  • Obtaining API Keys
• Resources
  • Introduction
  • Resource API Methods
    • Query Resources
    • Retrieve Region Details
    • Retrieve Region Properties
    • Retrieve Image Restrictions
    • Retrieve Resource Capabilities
    • Resource Details
    • Retrieve Resource Actions
    • Validate Resource
    • Resource Errors
• Resource Schema
• Instances
  • Introduction
  • Actions
  • Instance Methods
    • Create instance from resource
    • Retrieve request
    • Retrieve multiple requests
    • Create an instance from an instance
    • Retrieve instance
    • Retrieve multiple instances
    • Update instance
    • Update instance metadata
    • Delete instance
• Resource Types, Actions and Parameters
  • Resource Types
  • Virtual Machine (vm) Instance Schema
    • Method: vm.create
    • Method: vm.create.image
    • Method: vm.retrieve
    • Method: vm.retrieve.password
    • Method: vm.update.password
    • Method: vm.update.start
    • Method: vm.update.stop
    • Method: vm.update.reboot
    • Method: vm.delete
  • Key Pair (kp) Instance Schema
    • Method: kp.create
    • Method: kp.retrieve
    • Method: kp.delete
  • Security Group (sg) Instance Schema
    • Method: sg.create
    • Method: sg.retrieve
    • Method: sg.update.add-access
    • Method: sg.update.remove-access
    • Method: sg.delete
  • Volume Storage (vs) Instance Schema
    • Method: vs.create
    • Method: vs.retrieve
    • Method: vs.update.attach
    • Method: vs.update.detach
    • Method: vs.delete
  • Volume Snapshot (snap) Instance Schema
    • Method: snap.create
    • Method: snap.retrieve
    • Method: snap.delete
  • Floating IP Address (ip) Instance Schema
    • Method: ip.create
    • Method: ip.retrieve
    • Method: ip.update.add
    • Method: ip.update.remove
    • Method: ip.delete
  • Image (image) Instance Schema
    • Method: image.create
    • Method: image.retrieve
    • Method: image.delete
• Workloads
  • Introduction
  • Workload Methods
    • Create workload
    • Clone workload
    • Retrieve workload
    • Retrieve multiple workloads
    • Update workload
    • Delete workload
    • Create/Update workload element
    • Delete workload element
    • Plan workload
    • Execute workload plan
    • Retrieve transaction steps
    • Retrieve transaction errors
    • Retrieve transaction status
    • Cancel transaction
• Workload Schema
  • name
  • description
  • metadata
  • elements
• Workload Element Schema
  • name
  • uri
  • parameters
    • keyPair
    • securityGroups
    • attachTarget
  • metadata
• Getting Started with Instances
  • Create A Key Pair
  • Create A Virtual Machine
  • Create A Private Image from a Virtual Machine
• Getting Started with Workloads
  • Download and Install runcws
  • Set Up runcws
  • List (Retrieve Multiple) Workloads
  • Create Workload
  • Retrieve Workload
  • Clone Workload
  • Update Workload
  • Update Workload Element
  • Delete Workload Element
  • Delete Workload
  • Plan Workload Activation
    • plan.action
    • plan.expires
    • plan.elements
    • plan.serial
    • plan.inventory
    • plan.summary
    • Workload Steps
    • How the Plan is Generated
  • Execute Workload
    • Running Workload
    • Partial Failures and Rollback
  • Transaction Status
    • retries
    • timeout
    • cancelled
  • Transaction Steps
  • Transaction Errors
  • Transaction Completes
  • Cancel Transaction
  • Plan Workload Deactivation