Back to top

Hardware Reservations

Hardware Reservation Management

Retrieve all hardware reservations for a given project
GET
/projects/{id}/hardware-reservations

Provides a collection of hardware reservations for a given project.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    include
    string in query

    related attributes to include

    page
    integer in query

    page to display, default to 1, max 100_000

    per_page
    integer in query

    items per page, default to 10, max 1_000

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"hardware_reservations": [
    		{
    			"id": "string",
    			"short_id": "string",
    			"facility": {
    				"id": "string",
    				"name": "string",
    				"code": "string",
    				"features": [
    					"string"
    				],
    				"address": {
    					"$ref": "#\/definitions\/Address"
    				}
    			},
    			"plan": {
    				"id": "string",
    				"slug": "string",
    				"name": "string",
    				"description": "string",
    				"line": "string",
    				"specs": "object",
    				"pricing": "object",
    				"legacy": "boolean",
    				"class": "string",
    				"available_in": [
    					{
    						"href": "string"
    					}
    				]
    			},
    			"href": "string",
    			"project": {
    				"id": "string",
    				"name": "string",
    				"created_at": "string",
    				"updated_at": "string",
    				"max_devices": "object",
    				"members": [
    					{
    						"href": "string"
    					}
    				],
    				"memberships": [
    					{
    						"href": "string"
    					}
    				],
    				"network_status": "object",
    				"invitations": [
    					{
    						"href": "string"
    					}
    				],
    				"payment_method": {
    					"$ref": "#\/definitions\/Href"
    				},
    				"devices": [
    					{
    						"href": "string"
    					}
    				],
    				"ssh_keys": [
    					{
    						"href": "string"
    					}
    				],
    				"volumes": [
    					{
    						"href": "string"
    					}
    				],
    				"bgp_config": {
    					"$ref": "#\/definitions\/Href"
    				},
    				"customdata": "string"
    			},
    			"device": {
    				"id": "string",
    				"short_id": "string",
    				"hostname": "string",
    				"description": "string",
    				"state": "string",
    				"tags": [
    					"string"
    				],
    				"image_url": "string",
    				"billing_cycle": "string",
    				"user": "string",
    				"iqn": "string",
    				"locked": "boolean",
    				"bonding_mode": "integer",
    				"created_at": "string",
    				"updated_at": "string",
    				"spot_instance": "boolean",
    				"spot_price_max": "number",
    				"termination_time": "string",
    				"customdata": "string",
    				"provisioning_percentage": "number",
    				"operating_system": {
    					"$ref": "#\/definitions\/OperatingSystem"
    				},
    				"always_pxe": "boolean",
    				"ipxe_script_url": "string",
    				"location": {
    					"$ref": "#\/definitions\/HardwareLocation"
    				},
    				"facility": {
    					"$ref": "#\/definitions\/Facility"
    				},
    				"plan": {
    					"$ref": "#\/definitions\/Plan"
    				},
    				"userdata": "string",
    				"root_password": "string",
    				"href": "string",
    				"project": {
    					"$ref": "#\/definitions\/Href",
    					"description": "Full version of project object when included"
    				},
    				"project_lite": {
    					"$ref": "#\/definitions\/Href",
    					"description": "Lite version of project object when included"
    				},
    				"volumes": [
    					{
    						"href": "string"
    					}
    				],
    				"hardware_reservation": {
    					"$ref": "#\/definitions\/Href"
    				},
    				"ssh_keys": [
    					{
    						"href": "string"
    					}
    				],
    				"ip_addresses": [
    					{
    						"id": "string",
    						"address_family": "integer",
    						"netmask": "string",
    						"public": "boolean",
    						"enabled": "boolean",
    						"cidr": "integer",
    						"management": "boolean",
    						"manageable": "boolean",
    						"network": "string",
    						"address": "string",
    						"gateway": "string",
    						"href": "string",
    						"created_at": "string"
    					}
    				],
    				"provisioning_events": [
    					{
    						"id": "string",
    						"state": "string",
    						"type": "string",
    						"body": "string",
    						"relationships": "array",
    						"interpolated": "string",
    						"created_at": "string",
    						"href": "string"
    					}
    				]
    			},
    			"created_at": "string"
    		}
    	],
    	"meta": {
    		"first": {
    			"href": "string"
    		},
    		"previous": {
    			"href": "string"
    		},
    		"self": {
    			"href": "string"
    		},
    		"next": {
    			"href": "string"
    		},
    		"last": {
    			"href": "string"
    		},
    		"total": "integer"
    	}
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Retrieve a hardware reservation
GET
/hardware-reservations/{id}

Returns a single hardware reservation

  • Parameters
  • id
    string  (required) in path

    HardwareReservation UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"id": "string",
    	"short_id": "string",
    	"hostname": "string",
    	"description": "string",
    	"state": "string",
    	"tags": [
    		"string"
    	],
    	"image_url": "string",
    	"billing_cycle": "string",
    	"user": "string",
    	"iqn": "string",
    	"locked": "boolean",
    	"bonding_mode": "integer",
    	"created_at": "string",
    	"updated_at": "string",
    	"spot_instance": "boolean",
    	"spot_price_max": "number",
    	"termination_time": "string",
    	"customdata": "string",
    	"provisioning_percentage": "number",
    	"operating_system": {
    		"id": "string",
    		"slug": "string",
    		"name": "string",
    		"distro": "string",
    		"version": "string",
    		"provisionable_on": {
    			"type": "array",
    			"items": {
    				"type": "string"
    			}
    		}
    	},
    	"always_pxe": "boolean",
    	"ipxe_script_url": "string",
    	"location": {
    		"cage": "string",
    		"facility": "string",
    		"rack": "string",
    		"row": "string",
    		"switch": "string"
    	},
    	"facility": {
    		"id": "string",
    		"name": "string",
    		"code": "string",
    		"features": {
    			"type": "array",
    			"items": {
    				"type": "string"
    			}
    		},
    		"address": {
    			"address": "string",
    			"address2": "string",
    			"city": "string",
    			"state": "string",
    			"zip_code": "string",
    			"country": "string",
    			"coordinates": {
    				"latitude": "string",
    				"longitude": "string"
    			}
    		}
    	},
    	"plan": {
    		"id": "string",
    		"slug": "string",
    		"name": "string",
    		"description": "string",
    		"line": "string",
    		"specs": "object",
    		"pricing": "object",
    		"legacy": "boolean",
    		"class": "string",
    		"available_in": {
    			"type": "array",
    			"items": {
    				"$ref": "#\/definitions\/Href"
    			}
    		}
    	},
    	"userdata": "string",
    	"root_password": "string",
    	"href": "string",
    	"project": {
    		"href": "string"
    	},
    	"project_lite": {
    		"href": "string"
    	},
    	"volumes": [
    		{
    			"href": "string"
    		}
    	],
    	"hardware_reservation": {
    		"href": "string"
    	},
    	"ssh_keys": [
    		{
    			"href": "string"
    		}
    	],
    	"ip_addresses": [
    		{
    			"id": "string",
    			"address_family": "integer",
    			"netmask": "string",
    			"public": "boolean",
    			"enabled": "boolean",
    			"cidr": "integer",
    			"management": "boolean",
    			"manageable": "boolean",
    			"assigned_to": {
    				"href": "string"
    			},
    			"network": "string",
    			"address": "string",
    			"gateway": "string",
    			"href": "string",
    			"created_at": "string",
    			"parent_block": {
    				"network": "string",
    				"netmask": "string",
    				"cidr": "integer",
    				"href": "string"
    			}
    		}
    	],
    	"provisioning_events": [
    		{
    			"id": "string",
    			"state": "string",
    			"type": "string",
    			"body": "string",
    			"relationships": [
    				{
    					"href": "string"
    				}
    			],
    			"interpolated": "string",
    			"created_at": "string",
    			"href": "string"
    		}
    	]
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Move a hardware reservation
/hardware-reservations/{id}/move

Move a hardware reservation to another project

  • Parameters
  • project_id
    string  (required) in path

    Project UUID

  • Response  200   ok
  • {
    	"id": "string",
    	"short_id": "string",
    	"facility": {
    		"id": "string",
    		"name": "string",
    		"code": "string",
    		"features": {
    			"type": "array",
    			"items": {
    				"type": "string"
    			}
    		},
    		"address": {
    			"address": "string",
    			"address2": "string",
    			"city": "string",
    			"state": "string",
    			"zip_code": "string",
    			"country": "string",
    			"coordinates": {
    				"latitude": "string",
    				"longitude": "string"
    			}
    		}
    	},
    	"plan": {
    		"id": "string",
    		"slug": "string",
    		"name": "string",
    		"description": "string",
    		"line": "string",
    		"specs": "object",
    		"pricing": "object",
    		"legacy": "boolean",
    		"class": "string",
    		"available_in": {
    			"type": "array",
    			"items": {
    				"$ref": "#\/definitions\/Href"
    			}
    		}
    	},
    	"href": "string",
    	"project": {
    		"id": "string",
    		"name": "string",
    		"created_at": "string",
    		"updated_at": "string",
    		"max_devices": "object",
    		"members": {
    			"type": "array",
    			"items": {
    				"$ref": "#\/definitions\/Href"
    			}
    		},
    		"memberships": {
    			"type": "array",
    			"items": {
    				"$ref": "#\/definitions\/Href"
    			}
    		},
    		"network_status": "object",
    		"invitations": {
    			"type": "array",
    			"items": {
    				"$ref": "#\/definitions\/Href"
    			}
    		},
    		"payment_method": {
    			"href": "string"
    		},
    		"devices": {
    			"type": "array",
    			"items": {
    				"$ref": "#\/definitions\/Href"
    			}
    		},
    		"ssh_keys": {
    			"type": "array",
    			"items": {
    				"$ref": "#\/definitions\/Href"
    			}
    		},
    		"volumes": {
    			"type": "array",
    			"items": {
    				"$ref": "#\/definitions\/Href"
    			}
    		},
    		"bgp_config": {
    			"href": "string"
    		},
    		"customdata": "string"
    	},
    	"device": {
    		"id": "string",
    		"short_id": "string",
    		"hostname": "string",
    		"description": "string",
    		"state": "string",
    		"tags": {
    			"type": "array",
    			"items": {
    				"type": "string"
    			}
    		},
    		"image_url": "string",
    		"billing_cycle": "string",
    		"user": "string",
    		"iqn": "string",
    		"locked": "boolean",
    		"bonding_mode": "integer",
    		"created_at": "string",
    		"updated_at": "string",
    		"spot_instance": "boolean",
    		"spot_price_max": "number",
    		"termination_time": "string",
    		"customdata": "string",
    		"provisioning_percentage": "number",
    		"operating_system": {
    			"id": "string",
    			"slug": "string",
    			"name": "string",
    			"distro": "string",
    			"version": "string",
    			"provisionable_on": {
    				"type": "array",
    				"items": {
    					"type": "string"
    				}
    			}
    		},
    		"always_pxe": "boolean",
    		"ipxe_script_url": "string",
    		"location": {
    			"cage": "string",
    			"facility": "string",
    			"rack": "string",
    			"row": "string",
    			"switch": "string"
    		},
    		"facility": {
    			"id": "string",
    			"name": "string",
    			"code": "string",
    			"features": {
    				"type": "array",
    				"items": {
    					"type": "string"
    				}
    			},
    			"address": {
    				"address": "string",
    				"address2": "string",
    				"city": "string",
    				"state": "string",
    				"zip_code": "string",
    				"country": "string",
    				"coordinates": {
    					"$ref": "#\/definitions\/Coordinates"
    				}
    			}
    		},
    		"plan": {
    			"id": "string",
    			"slug": "string",
    			"name": "string",
    			"description": "string",
    			"line": "string",
    			"specs": "object",
    			"pricing": "object",
    			"legacy": "boolean",
    			"class": "string",
    			"available_in": {
    				"type": "array",
    				"items": {
    					"$ref": "#\/definitions\/Href"
    				}
    			}
    		},
    		"userdata": "string",
    		"root_password": "string",
    		"href": "string",
    		"project": {
    			"href": "string"
    		},
    		"project_lite": {
    			"href": "string"
    		},
    		"volumes": {
    			"type": "array",
    			"items": {
    				"$ref": "#\/definitions\/Href"
    			}
    		},
    		"hardware_reservation": {
    			"href": "string"
    		},
    		"ssh_keys": {
    			"type": "array",
    			"items": {
    				"$ref": "#\/definitions\/Href"
    			}
    		},
    		"ip_addresses": {
    			"type": "array",
    			"items": {
    				"$ref": "#\/definitions\/IPAssignment"
    			}
    		},
    		"provisioning_events": {
    			"type": "array",
    			"items": {
    				"$ref": "#\/definitions\/Event"
    			}
    		}
    	},
    	"created_at": "string"
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found