Update capacity

Update the fields of a capacity. Updating the requirements object will update the default requirements applied for instances in this capacity.

idstring required

Capacity ID or name

Request body

namestring nullable

Human-readable name for the capacity. Must be unique per owner if provided. Set to null to clear the name.

default_node_templatestring nullable

Default node template (ID or name). Must belong to the same owner.

start_nodes_automaticallyboolean nullable

If true nodes will be provisioned automatically using the capacity template as compute is procured.

Capacity updated successfully

object'capacity' required

Type identifier useful for discriminating union types.

idstring required

Generated ID with format 'cap_[0-9a-zA-Z]+' used for referencing a CapacityId resource.

namestring

A validated resource name. Must start with alphanumeric, followed by alphanumeric, '.', '_', or '-'. Max 255 characters.

default_node_templatestring

Generated ID with format 'ntmpl_[0-9a-zA-Z]+' used for referencing a NodeTemplateId resource.

start_nodes_automaticallyboolean required

If true nodes will be provisioned automatically using the capacity template as compute is procured.

created_atinteger required

Unix timestamp in seconds since epoch

{
  "object": "capacity",
  "schedule_info": {
    "total_schedule": {
      "object": "schedule"
    }
  }
}