Back to top

Instance Batches

Instance Batch Management

Create a devices batch
/projects/{id}/devices/batch

Creates a new batch of instances. Type-specific options (such as operating_system for baremetal devices) should be included in the main data structure alongside hostname and plan. The features attribute allows you to optionally specify what features your server should have. For example, if you require a server with a TPM chip, you may specify { "features": { "tpm": "required" } } (or { "features": ["tpm"] } in shorthand). The request will fail if there are no available servers matching your criteria. Alternatively, if you do not require a certain feature, but would prefer to be assigned a server with that feature if there are any available, you may specify that feature with a preferred value (see the example request below). The request will not fail if we have no servers with that feature in our inventory.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    batch
     (required) in body

    Batches to create

    {
    	"batches": [
    		"object"
    	]
    }
  • Response  201   created
  • {
    	"id": "string",
    	"state": "string",
    	"error_messages": [
    		"string"
    	],
    	"quantity": "integer",
    	"created_at": "string",
    	"href": "string",
    	"project": {
    		"href": "string"
    	},
    	"instances": {
    		"href": "string"
    	}
    }
  • Response  401   unauthorized
  • Response  422   unprocessable entity
  • Response  403   forbidden
  • Response  404   not found