Project Management. Check out the product docs to learn more about Projects.
Retrieve all batches by project
/projects/{id}/batches
Returns all batches for the given project
Requesting bgp config
/projects/{id}/bgp-configs
Requests to enable bgp configuration for a project.
Retrieve a bgp config
/projects/{id}/bgp-config
Returns a bgp config
Retrieve all BGP sessions for project
/projects/{id}/bgp/sessions
Provides a listing of available BGP sessions for the project.
Retrieve project's events
/projects/{id}/events
Returns a list of events for a single project
Retrieve all facilities visible by the project
/projects/{id}/facilities
Returns a listing of available datacenters for the given project
Retrieve all hardware reservations for a given project
/projects/{id}/hardware-reservations
Provides a collection of hardware reservations for a given project.
Retrieve all devices of a project
/projects/{id}/devices
Provides a collection of devices for a given project.
Create a device
/projects/{id}/devices
Creates a new device and provisions it in the specified location.
Device type-specific options are accepted. For example, `baremetal` devices accept `operating_system`, `hostname`, and `plan`. These parameters may not be accepted for other device types. The default device type is `baremetal`.
Retrieve project invitations
/projects/{project_id}/invitations
Returns all invitations in a project.
Create an invitation for a project
/projects/{project_id}/invitations
In order to add a user to a project, they must first be invited.
Retrieve all ip reservations
/projects/{id}/ips
Provides a list of IP resevations for a single project.
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, an IP reservation will be created. If the project will exceed its IP quota, a request will be submitted for review, and will return an IP Reservation with a state
of pending
. You can automatically have the request fail with HTTP status 422 instead of triggering the review process by providing the fail_on_approval_required
parameter set to true
in the request.
Retrieve all licenses
/projects/{id}/licenses
Provides a collection of licenses for a given project.
Create a License
/projects/{id}/licenses
Creates a new license for the given project
Retrieve project memberships
/projects/{project_id}/memberships
Returns all memberships in a project.
Retrieve the custom metadata of a project
/projects/{id}/customdata
Provides the custom metadata stored for this project in json format
Retrieve the custom metadata of an IP Reservation
/projects/{project_id}/ips/{id}/customdata
Provides the custom metadata stored for this IP Reservation in json format
Retrieve all plans visible by the project
/projects/{id}/plans
Returns a listing of available plans for the given project
Retrieve all projects of an organization
/organizations/{id}/projects
Returns a collection of projects that belong to the organization.
Create a project for the organization
/organizations/{id}/projects
Creates a new project for the organization
Retrieve all projects
/projects
Returns a collection of projects that the current user is a member of.
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.
Retrieve a project
/projects/{id}
Returns a single project if the user has access
Update the project
/projects/{id}
Updates the project.
Delete the project
/projects/{id}
Deletes the project.
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.
List spot market requests
/projects/{id}/spot-market-requests
View all spot market requests for a given project.
Retrieve a project's ssh keys
/projects/{id}/ssh-keys
Returns a collection of the project's ssh keys.
Create a ssh key for the given project
/projects/{id}/ssh-keys
Creates a ssh key.
Retrieve a device's ssh keys
/devices/{id}/ssh-keys
Returns a collection of the device's ssh keys.
Create a transfer request
/projects/{id}/transfers
Organization owners can transfer their projects to other organizations.
Retrieve all virtual networks
/projects/{id}/virtual-networks
Provides a list of virtual networks for a single project.
Create a virtual network
/projects/{id}/virtual-networks
Creates an virtual network.