Back to top

Projects

Project Management

Retrieve project's events
GET
/projects/{id}/events

Returns a list of events for a single 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
  • {
    	"events": [
    		{
    			"id": "string",
    			"state": "string",
    			"type": "string",
    			"body": "string",
    			"relationships": [
    				{
    					"href": "string"
    				}
    			],
    			"interpolated": "string",
    			"created_at": "string",
    			"href": "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 all devices of a project
GET
/projects/{id}/devices

Provides a collection of devices 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
  • {
    	"devices": [
    		{
    			"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": [
    					"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": [
    					"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"
    					}
    				]
    			},
    			"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": {
    						"$ref": "#\/definitions\/Href"
    					},
    					"network": "string",
    					"address": "string",
    					"gateway": "string",
    					"href": "string",
    					"created_at": "string",
    					"parent_block": {
    						"$ref": "#\/definitions\/ParentBlock"
    					}
    				}
    			],
    			"provisioning_events": [
    				{
    					"id": "string",
    					"state": "string",
    					"type": "string",
    					"body": "string",
    					"relationships": "array",
    					"interpolated": "string",
    					"created_at": "string",
    					"href": "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
Create a device
/projects/{id}/devices

Creates a new device and provisions it in our datacenter. 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

    device
     (required) in body

    Device to create

    {
    	"facility": "string",
    	"plan": "string",
    	"hostname": "string",
    	"description": "string",
    	"billing_cycle": "string",
    	"operating_system": "string",
    	"always_pxe": "boolean",
    	"ipxe_script_url": "string",
    	"userdata": "string",
    	"locked": "boolean",
    	"customdata": "string",
    	"hardware_reservation_id": "string",
    	"spot_instance": "boolean",
    	"spot_price_max": "number",
    	"termination_time": "string",
    	"tags": [
    		"string"
    	],
    	"project_ssh_keys": [
    		"string"
    	],
    	"user_ssh_keys": [
    		"string"
    	],
    	"features": [
    		"string"
    	],
    	"public_ipv4_subnet_size": "number"
    } 
  • Response  201   created
  • {
    	"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  422   unprocessable entity
  • Response  403   forbidden
  • Response  404   not found
Retrieve project invitations
/projects/{id}/invitations

Returns all invitations in a project.

  • Parameters
  • 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

    project_id
    string  (required) in path

    Project UUID

  • Response  200   ok
  • {
    	"invitations": [
    		{
    			"id": "string",
    			"roles": [
    				"string"
    			],
    			"created_at": "string",
    			"updated_at": "string",
    			"project": {
    				"href": "string"
    			},
    			"user": {
    				"href": "string"
    			},
    			"href": "string"
    		}
    	]
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Requesting ip reservations
/projects/{id}/ips

Request more IP space for a project in order to have additional IP addresses to assign to devices. If the request is within the max quota, ip reservation will be created, else, the request will be submitted.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    ip_reservation_request
     (required) in body

    IP Reservation Request to create

    {
    	"type": "string",
    	"quantity": "integer",
    	"comments": "string",
    	"facility": "string",
    	"customdata": "string"
    } 
  • Response  201   created
  • {
    	"message": {
    		"reasons": {
    			"type": "array",
    			"items": {
    				"type": "string"
    			}
    		},
    		"address": "string"
    	}
    } 
  • Response  204   no content
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
  • Response  422   unprocessable entity
Retrieve all projects
GET
/projects

Returns a collection of projects that the current user is a member of.

  • Parameters
  • 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
  • {
    	"projects": [
    		{
    			"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": {
    				"href": "string"
    			},
    			"devices": [
    				{
    					"href": "string"
    				}
    			],
    			"ssh_keys": [
    				{
    					"href": "string"
    				}
    			],
    			"volumes": [
    				{
    					"href": "string"
    				}
    			],
    			"bgp_config": {
    				"href": "string"
    			},
    			"customdata": "string"
    		}
    	],
    	"meta": {
    		"first": {
    			"href": "string"
    		},
    		"previous": {
    			"href": "string"
    		},
    		"self": {
    			"href": "string"
    		},
    		"next": {
    			"href": "string"
    		},
    		"last": {
    			"href": "string"
    		},
    		"total": "integer"
    	}
    } 
  • Response  401   unauthorized
Create a project
/projects

Creates a new project for the user default organization. If the user don't have an organization, a new one will be created.

  • Parameters
  • project
     (required) in body

    Project to create

    {
    	"name": "string",
    	"payment_method_id": "string",
    	"customdata": "string"
    } 
  • Response  201   created
  • {
    	"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": {
    		"href": "string"
    	},
    	"devices": [
    		{
    			"href": "string"
    		}
    	],
    	"ssh_keys": [
    		{
    			"href": "string"
    		}
    	],
    	"volumes": [
    		{
    			"href": "string"
    		}
    	],
    	"bgp_config": {
    		"href": "string"
    	},
    	"customdata": "string"
    } 
  • Response  401   unauthorized
  • Response  422   unprocessable entity
Retrieve a project
GET
/projects/{id}

Returns a single project if the user has access

  • Parameters
  • id
    string  (required) in path

    Project 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",
    	"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": {
    		"href": "string"
    	},
    	"devices": [
    		{
    			"href": "string"
    		}
    	],
    	"ssh_keys": [
    		{
    			"href": "string"
    		}
    	],
    	"volumes": [
    		{
    			"href": "string"
    		}
    	],
    	"bgp_config": {
    		"href": "string"
    	},
    	"customdata": "string"
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Update the project
PUT
/projects/{id}

Updates the project.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    project
     (required) in body

    Project to update

    {
    	"name": "string",
    	"payment_method_id": "string",
    	"backend_transfer_enabled": "boolean",
    	"customdata": "string"
    } 
  • Response  200   ok
  • {
    	"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": {
    		"href": "string"
    	},
    	"devices": [
    		{
    			"href": "string"
    		}
    	],
    	"ssh_keys": [
    		{
    			"href": "string"
    		}
    	],
    	"volumes": [
    		{
    			"href": "string"
    		}
    	],
    	"bgp_config": {
    		"href": "string"
    	},
    	"customdata": "string"
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
  • Response  422   unprocessable entity
Delete the project
/projects/{id}

Deletes the project.

  • Parameters
  • id
    string  (required) in path

    Project UUID

  • Response  204   no content
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Retrieve a project's ssk keys
GET
/projects/{id}/ssh-keys

Returns a collection of the project's ssh keys.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    Search string
    string in query

    Search in keys

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"ssh_keys": [
    		{
    			"id": "string",
    			"label": "string",
    			"key": "string",
    			"fingerprint": "string",
    			"created_at": "string",
    			"updated_at": "string",
    			"entity": {
    				"href": "string"
    			},
    			"href": "string"
    		}
    	]
    } 
  • Response  401   unauthorized
Create a ssh key for the given project
/projects/{id}/ssh-keys

Creates a ssh key.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    ssh key
     (required) in body

    ssh key to create

    {
    	"label": "string",
    	"key": "string"
    } 
  • Response  201   created
  • {
    	"id": "string",
    	"label": "string",
    	"key": "string",
    	"fingerprint": "string",
    	"created_at": "string",
    	"updated_at": "string",
    	"entity": {
    		"href": "string"
    	},
    	"href": "string"
    } 
  • Response  401   unauthorized
  • Response  422   unprocessable entity
Create a transfer request
/projects/{id}/transfers

Organization owners can transfer their projects to other organizations.

  • Parameters
  • id
    string  (required) in path

    UUID of the project to be transferred

    transfer_request
     (required) in body

    Transfer Request to create

    {
    	"target_organization_id": "string"
    } 
  • Response  201   created
  • {
    	"id": "string",
    	"created_at": "string",
    	"updated_at": "string",
    	"target_organization": {
    		"href": "string"
    	},
    	"project": {
    		"href": "string"
    	},
    	"href": "string"
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
  • Response  422   unprocessable entity
Retrieve all licenses
GET
/projects/{id}/licenses

Provides a collection of licenses for a given project.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"licenses": [
    		{
    			"id": "string",
    			"description": "string",
    			"license_key": "string",
    			"licensee_product": {
    				"href": "string"
    			},
    			"size": "number",
    			"project": {
    				"href": "string"
    			}
    		}
    	]
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Create a License
/projects/{id}/licenses

Creates a new license for the given project

  • Parameters
  • id
    string  (required) in path

    Project UUID

    license
     (required) in body

    License to create

    {
    	"description": "string",
    	"size": "number",
    	"licensee_product_id": "string"
    } 
  • Response  201   created
  • {
    	"id": "string",
    	"description": "string",
    	"license_key": "string",
    	"licensee_product": {
    		"href": "string"
    	},
    	"size": "number",
    	"project": {
    		"href": "string"
    	}
    } 
  • Response  401   unauthorized
  • Response  422   unprocessable entity
  • Response  403   forbidden
  • Response  404   not found
Retrieve all ip reservations
GET
/projects/{id}/ips

Provides a list of IP resevations for a single project.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"ip_addresses": [
    		{
    			"id": "string",
    			"address_family": "integer",
    			"netmask": "string",
    			"public": "boolean",
    			"enabled": "boolean",
    			"cidr": "integer",
    			"management": "boolean",
    			"manageable": "boolean",
    			"addon": "boolean",
    			"bill": "boolean",
    			"assignments": [
    				{
    					"id": "string",
    					"address_family": "integer",
    					"netmask": "string",
    					"public": "boolean",
    					"enabled": "boolean",
    					"cidr": "integer",
    					"management": "boolean",
    					"manageable": "boolean",
    					"assigned_to": {
    						"$ref": "#\/definitions\/Href"
    					},
    					"network": "string",
    					"address": "string",
    					"gateway": "string",
    					"href": "string",
    					"created_at": "string",
    					"parent_block": {
    						"$ref": "#\/definitions\/ParentBlock"
    					}
    				}
    			],
    			"network": "string",
    			"created_at": "string",
    			"facility": {
    				"id": "string",
    				"name": "string",
    				"code": "string",
    				"features": [
    					"string"
    				],
    				"address": {
    					"$ref": "#\/definitions\/Address"
    				}
    			},
    			"href": "string"
    		}
    	]
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
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 all batches by project
GET
/projects/{id}/batches

Returns all batches for the given project

  • Parameters
  • id
    string  (required) in path

    Project UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"batches": [
    		{
    			"id": "string",
    			"state": "string",
    			"error_messages": [
    				"string"
    			],
    			"quantity": "integer",
    			"created_at": "string",
    			"href": "string",
    			"project": {
    				"href": "string"
    			},
    			"instances": {
    				"href": "string"
    			}
    		}
    	]
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Retrieve all facilities visible by the project
GET
/projects/{id}/facilities

Returns a listing of available datacenters for the 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
  • {
    	"facilities": [
    		{
    			"id": "string",
    			"name": "string",
    			"code": "string",
    			"features": [
    				"string"
    			],
    			"address": {
    				"address": "string",
    				"address2": "string",
    				"city": "string",
    				"state": "string",
    				"zip_code": "string",
    				"country": "string",
    				"coordinates": {
    					"$ref": "#\/definitions\/Coordinates"
    				}
    			}
    		}
    	]
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Retrieve all plans visible by the project
GET
/projects/{id}/plans

Returns a listing of available services plans available for the 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
  • {
    	"plans": [
    		{
    			"id": "string",
    			"slug": "string",
    			"name": "string",
    			"description": "string",
    			"line": "string",
    			"specs": "object",
    			"pricing": "object",
    			"legacy": "boolean",
    			"class": "string",
    			"available_in": [
    				{
    					"href": "string"
    				}
    			]
    		}
    	]
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Create an invitation for a project
GET
/projects/{id}/invitations

In order to add a user to a project, they must first be invited.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    invitation
     (required) in body

    Invitation to create

    {
    	"invitee": "string",
    	"message": "string",
    	"roles": [
    		"string"
    	]
    } 
  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  201   created
  • {
    	"id": "string",
    	"roles": [
    		"string"
    	],
    	"invitee": "string",
    	"created_at": "string",
    	"updated_at": "string",
    	"invited_by": {
    		"href": "string"
    	},
    	"invitable": {
    		"href": "string"
    	},
    	"href": "string"
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
  • Response  422   unprocessable entity
Retrieve project memberships
GET
/projects/{id}/memberships

Returns all memberships in a project.

  • Parameters
  • 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

    project_id
    string  (required) in path

    Project UUID

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"memberships": [
    		{
    			"id": "string",
    			"roles": [
    				"string"
    			],
    			"created_at": "string",
    			"updated_at": "string",
    			"project": {
    				"href": "string"
    			},
    			"user": {
    				"href": "string"
    			},
    			"href": "string"
    		}
    	]
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Retrieve all projects of an organization
GET
/organizations/{id}/projects

Returns a collection of projects that belong to the organization.

  • Parameters
  • id
    string  (required) in path

    Organization 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
  • {
    	"projects": [
    		{
    			"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": {
    				"href": "string"
    			},
    			"devices": [
    				{
    					"href": "string"
    				}
    			],
    			"ssh_keys": [
    				{
    					"href": "string"
    				}
    			],
    			"volumes": [
    				{
    					"href": "string"
    				}
    			],
    			"bgp_config": {
    				"href": "string"
    			},
    			"customdata": "string"
    		}
    	],
    	"meta": {
    		"first": {
    			"href": "string"
    		},
    		"previous": {
    			"href": "string"
    		},
    		"self": {
    			"href": "string"
    		},
    		"next": {
    			"href": "string"
    		},
    		"last": {
    			"href": "string"
    		},
    		"total": "integer"
    	}
    } 
  • Response  401   unauthorized
Create a project for the organization
/organizations/{id}/projects

Creates a new project for the organization

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    project
     (required) in body

    Project to create

    {
    	"name": "string",
    	"payment_method_id": "string",
    	"customdata": "string"
    } 
  • Response  201   created
  • {
    	"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": {
    		"href": "string"
    	},
    	"devices": [
    		{
    			"href": "string"
    		}
    	],
    	"ssh_keys": [
    		{
    			"href": "string"
    		}
    	],
    	"volumes": [
    		{
    			"href": "string"
    		}
    	],
    	"bgp_config": {
    		"href": "string"
    	},
    	"customdata": "string"
    } 
  • Response  401   unauthorized
  • Response  422   unprocessable entity
Requesting bgp config
/projects/{id}/bgp-configs

Requests to enable bgp configuration for a project.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    bgp_config_request
     (required) in body

    BGP config Request to create

    {
    	"deployment_type": "string",
    	"asn": "integer",
    	"md5": "string",
    	"use_case": "string"
    } 
  • Response  204   no content
  • Response  403   forbidden
  • Response  401   unauthorized
  • Response  404   not found
  • Response  422   unprocessable entity
Retrieve a bgp config
GET
/projects/{id}/bgp-config

Returns a bgp config

  • Parameters
  • id
    string  (required) in path

    Project 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",
    	"status": "string",
    	"deployment_type": "string",
    	"asn": "integer",
    	"route_object": "string",
    	"md5": "string",
    	"max_prefix": "integer",
    	"project": {
    		"href": "string"
    	},
    	"created_at": "string",
    	"requested_at": "string",
    	"session": "object",
    	"href": "string"
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Retrieve all virtual networks
GET
/projects/{id}/virtual-networks

Provides a list of virtual networks for a single project.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"virtual_networks": [
    		{
    			"id": "string",
    			"description": "string",
    			"vxlan": "integer",
    			"facility": {
    				"href": "string"
    			},
    			"instances": [
    				{
    					"href": "string"
    				}
    			],
    			"assigned_to": {
    				"href": "string"
    			},
    			"href": "string"
    		}
    	]
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Create an virtual network
/projects/{id}/virtual-networks

Creates an virtual network.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    virtual_network
     (required) in body

    Virtual Network to create

    {
    	"project_id": "string",
    	"description": "string",
    	"facility": "string",
    	"vxlan": "integer",
    	"vlan": "integer"
    } 
  • Response  201   created
  • {
    	"id": "string",
    	"description": "string",
    	"vxlan": "integer",
    	"facility": {
    		"href": "string"
    	},
    	"instances": [
    		{
    			"href": "string"
    		}
    	],
    	"assigned_to": {
    		"href": "string"
    	},
    	"href": "string"
    } 
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
  • Response  422   unprocessable entity
Retrieve the custom metadata of a project
GET
/projects/{id}/customdata

Provides the custom metadata stored for this project in json format

  • Parameters
  • id
    string  (required) in path

    Project UUID

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Retrieve the custom metadata of an IP Reservation
GET
/projects/{project_id}/ips/{id}/customdata

Provides the custom metadata stored for this IP Reservation in json format

  • Parameters
  • project_id
    string  (required) in path

    Project UUID

    id
    string  (required) in path

    Ip Reservation UUID

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • Response  401   unauthorized
  • Response  403   forbidden
  • Response  404   not found
Retrieve all BGP sessions for project
GET
/projects/{id}/bgp/sessions

Provides a listing of available BGP sessions for the project.

  • Parameters
  • id
    string  (required) in path

    Project UUID

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"bgp_sessions": [
    		{
    			"id": "string",
    			"status": "string",
    			"learned_routes": [
    				"string"
    			],
    			"address_family": "string",
    			"device": {
    				"href": "string"
    			},
    			"href": "string"
    		}
    	]
    } 
  • Response  401   unauthorized
  • Response  404   not found
Create a spot market request
/projects/{id}/spot-market-request

Creates a new spot market request. 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

    spot_market_request
     (required) in body

    Spot Market Request to create

    {
    	"instance_attributes": "object",
    	"devices_min": "integer",
    	"devices_max": "integer",
    	"max_bid_price": "number",
    	"end_at": "string",
    	"facilities": [
    		"string"
    	]
    } 
  • Response  201   created
  • {
    	"id": "string",
    	"devices_min": "integer",
    	"devices_max": "integer",
    	"max_bid_price": "number",
    	"created_at": "string",
    	"end_at": "string",
    	"href": "string",
    	"facilities": {
    		"href": "string"
    	},
    	"project": {
    		"href": "string"
    	},
    	"instances": {
    		"href": "string"
    	}
    } 
  • Response  401   unauthorized
  • Response  422   unprocessable entity
  • Response  404   not found
List spot market requests
GET
/projects/{id}/spot-market-request

View all spot market requests for a given project.

  • Parameters
  • id
    string  (required) in path

    Project UUID

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"spot_market_requests": [
    		{
    			"id": "string",
    			"devices_min": "integer",
    			"devices_max": "integer",
    			"max_bid_price": "number",
    			"created_at": "string",
    			"end_at": "string",
    			"href": "string",
    			"facilities": {
    				"href": "string"
    			},
    			"project": {
    				"href": "string"
    			},
    			"instances": {
    				"href": "string"
    			}
    		}
    	]
    } 
  • Response  401   unauthorized
  • Response  404   not found
Create a spot market request
/projects/{id}/spot-market-requests

Creates a new spot market request. 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

    spot_market_request
     (required) in body

    Spot Market Request to create

    {
    	"instance_attributes": "object",
    	"devices_min": "integer",
    	"devices_max": "integer",
    	"max_bid_price": "number",
    	"end_at": "string",
    	"facilities": [
    		"string"
    	]
    } 
  • Response  201   created
  • {
    	"id": "string",
    	"devices_min": "integer",
    	"devices_max": "integer",
    	"max_bid_price": "number",
    	"created_at": "string",
    	"end_at": "string",
    	"href": "string",
    	"facilities": {
    		"href": "string"
    	},
    	"project": {
    		"href": "string"
    	},
    	"instances": {
    		"href": "string"
    	}
    } 
  • Response  401   unauthorized
  • Response  422   unprocessable entity
  • Response  404   not found
List spot market requests
GET
/projects/{id}/spot-market-requests

View all spot market requests for a given project.

  • Parameters
  • id
    string  (required) in path

    Project UUID

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide
  • Response  200   ok
  • {
    	"spot_market_requests": [
    		{
    			"id": "string",
    			"devices_min": "integer",
    			"devices_max": "integer",
    			"max_bid_price": "number",
    			"created_at": "string",
    			"end_at": "string",
    			"href": "string",
    			"facilities": {
    				"href": "string"
    			},
    			"project": {
    				"href": "string"
    			},
    			"instances": {
    				"href": "string"
    			}
    		}
    	]
    } 
  • Response  401   unauthorized
  • Response  404   not found