Hint: Packet's API can be reached at https://api.packet.net

Most of the endpoints in the Packet API require authentication. Authenticating is done with an authentication token in the X-Auth-Token header.

curl -H 'X-Auth-Token: my_authentication_token'

Authentication tokens are used to identify the user your application is connecting to the Packet API on behalf of. Think of authentication tokens as permanent sessions—the user creates authentication tokens, and your app can use them to connect to the Packet API on their behalf until they delete the token.

Users can create authentication tokens in the Packet Portal.

The Packet API uses a few methods to minimize network traffic and bandwidth:

include

For resources that contain collections of other resources, the Packet API will return links to the other resources by default.

{
  ...
  // Includes "href" links if the resource is reachable through the API.
  "projects": [
    { "href": "/projects/5b590e4f-be96-4400-ae32-c315ee67964d" },
    { "href": "/projects/f3f131c8-f302-49ef-8c44-9405022dc6dd" }
  ],
  // Includes "id" attributes if not.
  "emails": [
    { "id": "eb5d8c89-4d15-4c87-859c-5ae190ad5d9a" },
    { "id": "c17f77ad-9070-4084-abaa-7538581d9523" }
  ]
  ...
}

However, if you're interested in acting on resources in the projects collection, it doesn't make sense to make a separate API call to retrieve each project. Instead, you can specify which collections you'd like to be included using the include parameter.

/user?include=projects

will return

{
  ...
  "projects": [
    {
      "href": "/projects/c851d3c5-d55d-4b1a-99f1-96fc64768bc3",
      "id": "c851d3c5-d55d-4b1a-99f1-96fc64768bc3",
      "name": "Project 1",
      ...
    },
    {
      "href": "/projects/21f8e88b-bd4e-44ca-b956-4f3f88e6e5f2",
      "id": "21f8e88b-bd4e-44ca-b956-4f3f88e6e5f2",
      "name": "Project 2",
      ...
    }
  ],
  ...
}

The include parameter is accepted for all GET requests on all resources and collections, and should be specified as a comma-separated list.

/user?include=emails,projects,memberships

You may also include nested associations up to 3 levels deep using dot notation:

/user?include=memberships.projects

Packet uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, a charge failed, etc.). Codes in the 5xx range indicate an error with Packet's servers (these are rare).

HTTP status code summary

200 - OK Everything worked as expected.
422 - Bad Request The request was unacceptable, often due to missing a required parameter.
401 - Unauthorized No valid API key provided.
404 - Not Found The requested resource doesn't exist.
500, 502, 503, 504 - Server Errors Something went wrong on Packet's end. (These are rare.)

Manage device batches. See project endpoints to list batches for a particular project.

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

Retrieve a Batch

GET
/batches/{id}

Returns a Batch

  • Parameters
  • id
    string  (required) in path

    Batch UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Delete the Batch

/batches/{id}

Deletes the Batch.

  • Parameters
  • id
    string  (required) in path

    Batch UUID

    remove_associated_instances
    boolean in path

    Remove instances associated to the batch

Create a devices batch

/projects/{id}/devices/batch

Creates new devices in batch and provisions them 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.

The facilities attribute specifies in what datacenter you wish to create the device.

You can either specify a single facility { "facility": "f1" } , or you can instruct to create the device in the best available datacenter { "facility": "any" }. Additionally it is possible to set a prioritized location selection.

For example { "facility": ["f3", "f2", "any"] } will try to assign to the facility f3, if there are no available f2, and so on. If "any" is not specified for "facility", the request will fail unless it can assign in the selected locations.

With { "facility": "any" } you have the option to diversify to indicate how many facilities you are willing to be spread across. For this purpose use parameter: facility_diversity_level = N.

For example:

{ "facilities": ["sjc1", "ewr1", "any"] , "facility_diversity_level" = 1, "quantity" = 10 } will assign 10 devices into the same facility, trying first in "sjc1", and if there aren’t available, it will try in "ewr1", otherwise any other.

The ip_addresses attribute will allow you to specify the addresses you want created with your device.

To maintain backwards compatibility, If the attribute is not sent in the request, it will be treated as if { "ip_addresses": [{ "address_family": 4, "public": true }, { "address_family": 4, "public": false }, { "address_family": 6, "public": true }] } was sent.

The private IPv4 address is required and always need to be sent in the array. Not all operating systems support no public IPv4 address, so in those cases you will receive an error message.

For example, to only configure your server with a private IPv4 address, you can send { "ip_addresses": [{ "address_family": 4, "public": false }] }.

To access a server without public IPs, you can use our Out-of-Band console access (SOS) or use another server with public IPs as a proxy.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    batch
     (required) in body

    Batches to create

    {
    	"batches": [
    		{
    			"type": "object",
    			"plan": "string",
    			"hostname": "string",
    			"hostnames": "array",
    			"description": "string",
    			"billing_cycle": "string",
    			"operating_system": "string",
    			"always_pxe": "boolean",
    			"userdata": "string",
    			"locked": "boolean",
    			"termination_time": "string",
    			"tags": "array",
    			"project_ssh_keys": "array",
    			"user_ssh_keys": "array",
    			"features": "array",
    			"customdata": "string",
    			"ip_addresses": "array"
    		}
    	]
    } 

BGP

Manage BGP configs and sessions. See device endpoints to create and list BGP sessions for a particular device.

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, asn

    {
    	"deployment_type": "string",
    	"asn": "integer",
    	"md5": "string",
    	"use_case": "string"
    } 

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

Retrieve all BGP sessions for project

GET
/projects/{id}/bgp/sessions

Provides a listing of available BGP sessions for the project.

Retrieve all BGP sessions

GET
/devices/{id}/bgp/sessions

Provides a listing of available BGP sessions for the device.

Create a BGP session

/devices/{id}/bgp/sessions

Creates a BGP session.

  • Parameters
  • id
    string  (required) in path

    Device UUID

    address_family
    in Address family for BGP session. Expected value is "ipv4" or "ipv6".

    1

    default_route
    boolean in body

    Default route

Retrieve a BGP session

GET
/bgp/sessions/{id}

Returns a BGP session

  • Parameters
  • id
    string  (required) in path

    BGP session UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Delete the BGP session

/bgp/sessions/{id}

Deletes the BGP session.

  • Parameters
  • id
    string  (required) in path

    BGP session UUID

Update the BGP session

PUT
/bgp/sessions/{id}

Updates the BGP session by either enabling or disabling the default route functionality.

  • Parameters
  • id
    string  (required) in path

    BGP session UUID

    default_route
    boolean  (required) in body

    Default route

Capacity Management

View capacity

GET
/capacity

Returns a list of facilities and plans with their current capacity.

Check capacity

/capacity

Validates if a deploy can be fulfilled.

Response:

"servers": [
    { "available": true, ... },
    { "available": false, ... }
]
  • Parameters
  • facility
     (required) in body

    Facility to create

    {
    	"servers": [
    		{
    			"facility": "string",
    			"plan": "string",
    			"quantity": "string"
    		}
    	]
    } 

Device Management

Retrieve all BGP sessions

GET
/devices/{id}/bgp/sessions

Provides a listing of available BGP sessions for the device.

Create a BGP session

/devices/{id}/bgp/sessions

Creates a BGP session.

  • Parameters
  • id
    string  (required) in path

    Device UUID

    address_family
    in Address family for BGP session. Expected value is "ipv4" or "ipv6".

    1

    default_route
    boolean in body

    Default route

Retrieve device's events

GET
/devices/{id}/events

Returns a list of events pertaining to a specific device

  • Parameters
  • id
    string  (required) in path

    Device 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

Perform an action

/devices/{id}/actions

Performs an action for the given device. Possible actions include: power_on, power_off, reboot, reinstall, and rescue (reboot the device into rescue OS.)

  • Parameters
  • id
    string  (required) in path

    Device UUID

    type
    string  (required) in query

    Action to perform

Retrieve all devices of an organization

GET
/organizations/{id}/devices

Provides a collection of devices for a given 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

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

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.

The facilities attribute specifies in what datacenter you wish to create the device.

You can either specify a single facility { "facility": "f1" } , or you can instruct to create the device in the best available datacenter { "facility": "any" }. Additionally it is possible to set a prioritized location selection.

For example { "facility": ["f3", "f2", "any"] } will try to assign to the facility f3, if there are no available f2, and so on. If "any" is not specified for "facility", the request will fail unless it can assign in the selected locations.

The `ip_addresses attribute will allow you to specify the addresses you want created with your device.

To maintain backwards compatibility, If the attribute is not sent in the request, it will be treated as if { "ip_addresses": [{ "address_family": 4, "public": true }, { "address_family": 4, "public": false }, { "address_family": 6, "public": true }] } was sent.

The private IPv4 address is required and always need to be sent in the array. Not all operating systems support no public IPv4 address, so in those cases you will receive an error message.

For example, to only configure your server with a private IPv4 address, you can send { "ip_addresses": [{ "address_family": 4, "public": false }] }.

To access a server without public IPs, you can use our Out-of-Band console access (SOS) or use another server with public IPs as a proxy.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    device
     (required) in body

    Device to create

    facility, plan, operating_system

    {
    	"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",
    	"private_ipv4_subnet_size": "number",
    	"ip_addresses": [
    		{
    			"type": "object",
    			"address_family": "number",
    			"public": "boolean",
    			"cidr": "number"
    		}
    	]
    } 

Retrieve a device

GET
/devices/{id}

Type-specific options (such as facility for baremetal devices) will be included as part of the main data structure. State value can be one of: active inactive queued or provisioning

  • Parameters
  • id
    string  (required) in path

    Device UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Update the device

PUT
/devices/{id}

Updates the device.

  • Parameters
  • id
    string  (required) in path

    Device UUID

    device
     (required) in body

    Facility to update

    {
    	"hostname": "string",
    	"description": "string",
    	"billing_cycle": "string",
    	"userdata": "string",
    	"locked": "boolean",
    	"tags": [
    		"string"
    	],
    	"always_pxe": "boolean",
    	"ipxe_script_url": "string",
    	"spot_instance": "boolean",
    	"customdata": "string"
    } 

Delete the device

/devices/{id}

Deletes a device and deprovisions it in our datacenter.

  • Parameters
  • id
    string  (required) in path

    Device UUID

    force_delete
    boolean in query

    Force the deletion of the device, by detaching any storage volume still active.

Create a devices batch

/projects/{id}/devices/batch

Creates new devices in batch and provisions them 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.

The facilities attribute specifies in what datacenter you wish to create the device.

You can either specify a single facility { "facility": "f1" } , or you can instruct to create the device in the best available datacenter { "facility": "any" }. Additionally it is possible to set a prioritized location selection.

For example { "facility": ["f3", "f2", "any"] } will try to assign to the facility f3, if there are no available f2, and so on. If "any" is not specified for "facility", the request will fail unless it can assign in the selected locations.

With { "facility": "any" } you have the option to diversify to indicate how many facilities you are willing to be spread across. For this purpose use parameter: facility_diversity_level = N.

For example:

{ "facilities": ["sjc1", "ewr1", "any"] , "facility_diversity_level" = 1, "quantity" = 10 } will assign 10 devices into the same facility, trying first in "sjc1", and if there aren’t available, it will try in "ewr1", otherwise any other.

The ip_addresses attribute will allow you to specify the addresses you want created with your device.

To maintain backwards compatibility, If the attribute is not sent in the request, it will be treated as if { "ip_addresses": [{ "address_family": 4, "public": true }, { "address_family": 4, "public": false }, { "address_family": 6, "public": true }] } was sent.

The private IPv4 address is required and always need to be sent in the array. Not all operating systems support no public IPv4 address, so in those cases you will receive an error message.

For example, to only configure your server with a private IPv4 address, you can send { "ip_addresses": [{ "address_family": 4, "public": false }] }.

To access a server without public IPs, you can use our Out-of-Band console access (SOS) or use another server with public IPs as a proxy.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    batch
     (required) in body

    Batches to create

    {
    	"batches": [
    		{
    			"type": "object",
    			"plan": "string",
    			"hostname": "string",
    			"hostnames": "array",
    			"description": "string",
    			"billing_cycle": "string",
    			"operating_system": "string",
    			"always_pxe": "boolean",
    			"userdata": "string",
    			"locked": "boolean",
    			"termination_time": "string",
    			"tags": "array",
    			"project_ssh_keys": "array",
    			"user_ssh_keys": "array",
    			"features": "array",
    			"customdata": "string",
    			"ip_addresses": "array"
    		}
    	]
    } 

Retrieve an instance bandwidth

GET
/devices/{id}/bandwidth

Retrieve an instance bandwidth for a given period of time.

  • Parameters
  • id
    string  (required) in path

    Device UUID

    from
    string  (required) in query

    Timestamp from range

    until
    string  (required) in query

    Timestamp to range

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Retrieve all ip assignments

GET
/devices/{id}/ips

Returns all ip assignments for a device.

  • Parameters
  • id
    string  (required) in path

    Device UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Create a ip assignment

/devices/{id}/ips

Creates an ip assignment for a device.

  • Parameters
  • id
    string  (required) in path

    Device UUID

    ip_assignment
     (required) in body

    IPAssignment to create

    address

    {
    	"address": "string",
    	"manageable": "boolean",
    	"customdata": "string"
    } 

Provides the custom metadata stored for this instance in json format

Retrieve the custom metadata of an IP Assignment

GET
/devices/:instance_id/ips/:id/customdata

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

  • Parameters
  • project_id
    string  (required) in path

    Project UUID

    id
    string  (required) in path

    Ip Assignment UUID

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Retrieve device traffic

GET
/devices/{id}/traffic

Returns traffic for a specific device.

  • Parameters
  • id
    string  (required) in path

    Device UUID

    direction
    string  (required) in query

    Traffic direction

    timeframe
     (required) in body

    Traffic timeframe

    started_at, ended_at

    {
    	"started_at": "string",
    	"ended_at": "string"
    } 
    interval
    string in query

    Traffic interval

    bucket
    string in query

    Traffic bucket

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Email Management

Add a new email address to the current user.

  • Parameters
  • email
     (required) in body

    Email to create

    address

    {
    	"address": "string",
    	"default": "boolean"
    } 

Retrieve an email

GET
/emails/{id}

Provides one of the user’s emails.

  • Parameters
  • id
    string  (required) in path

    Email UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Update the email

PUT
/emails/{id}

Updates the email.

  • Parameters
  • id
    string  (required) in path

    Email UUID

    email
     (required) in body

    email to update

    address

    {
    	"address": "string",
    	"default": "boolean"
    } 

Delete the email

/emails/{id}

Deletes the email.

  • Parameters
  • id
    string  (required) in path

    Email UUID

Event Management

Retrieve device's events

GET
/devices/{id}/events

Returns a list of events pertaining to a specific device

  • Parameters
  • id
    string  (required) in path

    Device 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

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

Retrieve volume's events

GET
/volumes/{id}/events

Returns a list of the current volume’s events

  • Parameters
  • id
    string  (required) in path

    Volume 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

Returns a list of the current user’s events

  • 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

Retrieve an event

GET
/events/{id}

Returns a single event if the user has access

  • Parameters
  • id
    string  (required) in path

    Event UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Facility Management

Provides a listing of available datacenters where you can provision Packet devices.

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

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

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

Move a hardware reservation

/hardware-reservations/{id}/move

Move a hardware reservation to another project

  • Parameters
  • project_id
    string  (required) in path

    Project UUID

Manage invitations. See project endpoints to create a new invitation.

View an invitation

GET
/invitations/{id}

Returns a single invitation. (It include the invitable to maintain backward compatibility but will be removed soon)

  • Parameters
  • id
    string  (required) in path

    Invitation UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Accept an invitation

PUT
/invitations/{id}

Accept an invitation.

  • Parameters
  • id
    string  (required) in path

    Invitation UUID

Decline an invitation

/invitations/{id}

Decline an invitation.

  • Parameters
  • id
    string  (required) in path

    Invitation UUID

Retrieve project invitations

GET
/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 Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Create an invitation for a project

/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

    {
    	"invitee": "string",
    	"message": "string",
    	"roles": [
    		"string"
    	],
    	"projects_ids": [
    		"string"
    	]
    } 

Retrieve organization invitations

GET
/organizations/{id}/invitations

Returns all invitations in an organization.

  • 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

    id
    string  (required) in path

    Organization UUID

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Create an invitation for an organization

/organizations/{id}/invitations

In order to add a user to an organization, they must first be invited. To invite to several projects the parameter projects_ids:[a,b,c] can be used

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    invitation
     (required) in body

    Invitation to create

    invitee

    {
    	"invitee": "string",
    	"message": "string",
    	"roles": [
    		"string"
    	],
    	"projects_ids": [
    		"string"
    	]
    } 

Returns all invitations in current user.

  • 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

    id
    string  (required) in path

    User UUID

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Manage IP addresses. See device and project endpoints to list and create IP assignments for a particular project or device.

Returns a single ip address if the user has access.

  • Parameters
  • id
    string  (required) in path

    IP Address UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Note! This call can be used to un-assign an IP assignment or delete an IP reservation. Un-assign an IP address record. Use the assignment UUID you get after attaching the IP. This will remove the relationship between an IP and the device and will make the IP address available to be assigned to another device. Delete and IP reservation. Use the reservation UUID you get after adding the IP to the project. This will permanently delete the IP block reservation from the project.

  • Parameters
  • id
    string  (required) in path

    IP Address UUID

Retrieve all ip assignments

GET
/devices/{id}/ips

Returns all ip assignments for a device.

  • Parameters
  • id
    string  (required) in path

    Device UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Create a ip assignment

/devices/{id}/ips

Creates an ip assignment for a device.

  • Parameters
  • id
    string  (required) in path

    Device UUID

    ip_assignment
     (required) in body

    IPAssignment to create

    address

    {
    	"address": "string",
    	"manageable": "boolean",
    	"customdata": "string"
    } 

Provides a list of IP resevations for a single project.

  • Parameters
  • id
    string  (required) in path

    IP Reservation UUID

    cidr
    string  (required) in query

    Size of subnets in bits

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

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

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, quantity

    {
    	"type": "string",
    	"quantity": "integer",
    	"comments": "string",
    	"facility": "string",
    	"customdata": "string"
    } 

Provides the custom metadata stored for this IP Reservation or IP Assignment 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

Manage licenses. See project endpoints to list and create licenses for a particular project.

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

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"
    } 

Retrieve a license

GET
/licenses/{id}

Returns a license

  • Parameters
  • id
    string  (required) in path

    License UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Update the license

PUT
/licenses/{id}

Updates the license.

  • Parameters
  • id
    string  (required) in path

    License UUID

    license
     (required) in body

    License to update

    {
    	"description": "string",
    	"size": "number"
    } 

Delete the license

/licenses/{id}

Deletes a license.

  • Parameters
  • id
    string  (required) in path

    License UUID

Spot Market Prices Management

Get current spot market prices

GET
/market/spot/prices

Get Packet current spot market prices.

  • Parameters
  • facility
    string in query

    Facility to check spot market prices

    plan
    string in query

    Plan to check spot market prices

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Get spot market prices for a given plan and facility in a fixed period of time

Note: In the 200 response, the property datapoints contains arrays of [float, integer].

  • Parameters
  • facility
    string  (required) in query

    Facility to check spot market prices

    plan
    string  (required) in query

    Plan to check spot market prices

    from
    string  (required) in query

    Timestamp from range

    until
    string  (required) in query

    Timestamp to range

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Membership Management (Project)

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

Retrieve a membership

GET
/memberships/{id}

Returns a single membership.

  • Parameters
  • id
    string  (required) in path

    Membership UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Update the membership

PUT
/memberships/{id}

Updates the membership.

  • Parameters
  • id
    string  (required) in path

    Membership UUID

    membership
     (required) in body

    Membership to update

    {
    	"role": [
    		"string"
    	]
    } 

Delete the membership

/memberships/{id}

Deletes the membership.

  • Parameters
  • id
    string  (required) in path

    Membership UUID

Notification Management

Returns a collection of the current user’s notification.

Operating System Management

Retrieve all operating systems

GET
/operating-systems

Provides a listing of available operating systems to provision your new device with.

Organizations Management

Retrieve all devices of an organization

GET
/organizations/{id}/devices

Provides a collection of devices for a given 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

Retrieve organization invitations

GET
/organizations/{id}/invitations

Returns all invitations in an organization.

  • 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

    id
    string  (required) in path

    Organization UUID

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Create an invitation for an organization

/organizations/{id}/invitations

In order to add a user to an organization, they must first be invited. To invite to several projects the parameter projects_ids:[a,b,c] can be used

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    invitation
     (required) in body

    Invitation to create

    invitee

    {
    	"invitee": "string",
    	"message": "string",
    	"roles": [
    		"string"
    	],
    	"projects_ids": [
    		"string"
    	]
    } 

Retrieve the custom metadata of an organization

GET
/organizations/{id}/customdata

Provides the custom metadata stored for this organization in json format

Returns a list of organizations that are accessible to the current user.

  • Parameters
  • personal
    string in query

    Include, exclude or show only personal organizations.

    without_projects
    string in query

    Include, exclude or show only organizations that have no projects.

    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

Create an organization

/organizations

Creates an organization.

  • Parameters
  • organization
     (required) in body

    Organization to create

    {
    	"name": "string",
    	"description": "string",
    	"website": "string",
    	"twitter": "string",
    	"logo": "string",
    	"address": {
    		"$ref": "#\/definitions\/Address"
    	},
    	"billing_address": {
    		"$ref": "#\/definitions\/Address"
    	},
    	"customdata": "string",
    	"enforce_2fa_at": "string"
    } 

Returns a single organization's details, if the user is authorized to view it.

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Update the organization

PUT
/organizations/{id}

Updates the organization.

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    organization
     (required) in body

    Organization to update

    {
    	"name": "string",
    	"description": "string",
    	"website": "string",
    	"twitter": "string",
    	"logo": "string",
    	"address": {
    		"$ref": "#\/definitions\/Address"
    	},
    	"billing_address": {
    		"$ref": "#\/definitions\/Address"
    	},
    	"customdata": "string",
    	"enforce_2fa_at": "string"
    } 

Delete the organization

/organizations/{id}

Deletes the organization.

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    id
    string  (required) in path

    Cage UUID

Retrieve all payment methods of an organization

GET
/organizations/{id}/payment-methods

Returns all payment methods of an organization.

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Create a payment method for the given organization

/organizations/{id}/payment-methods

Creates a payment method.

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    payment_method
     (required) in body

    Payment Method to create

    name, nonce

    {
    	"name": "string",
    	"nonce": "string",
    	"default": "boolean"
    } 

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

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

    {
    	"name": "string",
    	"payment_method_id": "string",
    	"customdata": "string"
    } 

Provides a collection of project transfer requests from or 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

Manage Packet Connect connections

List all Packet Connect connections

GET
/packet-connect/connections

Provides a listing of current Packet Connect connections.

Insert a new Packet Connect connection record into the project, and trigger provisioning operations for the connection in Packet and the cloud provider.

  • Parameters
  • connection
     (required) in body

    The new connection record to create

    {
    	"name": "string",
    	"project_id": "string",
    	"provider_id": "string",
    	"provider_payload": "string",
    	"facility": "string",
    	"port_speed": "integer",
    	"vlan": "integer",
    	"tags": [
    		"string"
    	],
    	"description": "string"
    } 

Retrieve a Packet Connect connection

GET
/packet-connect/connections/{id}

Get the details for a particular Packet Connect connection

  • Parameters
  • id
    string  (required) in path

    Connection UUID

    project_id
    string  (required) in query

    Project UUID

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Delete a Packet Connect connection record

/packet-connect/connections/{id}

Remove the Packet Connect connection from the project. Note: A connection must be deprovisioned before it can be deleted.

  • Parameters
  • id
    string  (required) in path

    Connection UUID

    project_id
    string  (required) in query

    Project UUID

Update a Packet Connect connection record

PUT
/packet-connect/connections/{id}

Update an existing new Packet Connect connection record.

  • Parameters
  • id
    string  (required) in path

    Connection UUID

    connection
     (required) in body

    The connection record fields to update

    {
    	"name": "string",
    	"description": "string"
    } 

Trigger a call to the cloud provider specified for the connection to mark the connection as provisioned.

  • Parameters
  • id
    string  (required) in path

    Connection UUID

    project_id
    string  (required) in query

    Project UUID

Trigger a call to the cloud provider specified for the connection to mark the connection as no longer provisioned.

  • Parameters
  • id
    string  (required) in path

    Connection UUID

    project_id
    string  (required) in query

    Project UUID

    delete
    boolean in query

    Delete the Packet Connect connection after it has been deprovisioned.

List all Packet Connect providers

GET
/packet-connect/providers

Provides a listing of available providers with which a Packet Connect connection may be established.

Retrieve a Packet Connect provider

GET
/packet-connect/providers/{id}

Get the details for a particular Packet Connect provider

Payment Method Management

Retrieve all payment methods of an organization

GET
/organizations/{id}/payment-methods

Returns all payment methods of an organization.

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Create a payment method for the given organization

/organizations/{id}/payment-methods

Creates a payment method.

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    payment_method
     (required) in body

    Payment Method to create

    name, nonce

    {
    	"name": "string",
    	"nonce": "string",
    	"default": "boolean"
    } 

Retrieve a payment method

GET
/payment-methods/{id}

Returns a payment method

  • Parameters
  • id
    string  (required) in path

    Payment Method UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Update the payment method

PUT
/payment-methods/{id}

Updates the payment method.

  • Parameters
  • id
    string  (required) in path

    Payment Method UUID

    payment_method
     (required) in body

    Payment Method to update

    {
    	"name": "string",
    	"default": "boolean",
    	"cardholder_name": "string",
    	"expiration_month": "string",
    	"expiration_year": "integer",
    	"billing_address": "object"
    } 

Delete the payment method

/payment-methods/{id}

Deletes the payment method.

  • Parameters
  • id
    string  (required) in path

    Payment Method UUID

Plan Management (Device)

Provides a listing of available services plans available to provision your device on.

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

Port Management

Assign a port for a hardware to virtual network.

  • Parameters
  • id
    string  (required) in path

    Port UUID

    vnid
     (required) in body

    Virtual Network ID

    {
    	"vnid": "string"
    } 

Unassign a port

/ports/{id}/unassign

Unassign a port for a hardware.

  • Parameters
  • id
    string  (required) in path

    Port UUID

    vnid
     (required) in body

    Virtual Network ID

    {
    	"vnid": "string"
    } 

Disabling bonding

/ports/{id}/disbond

Disabling bonding for one or all ports

  • Parameters
  • id
    string  (required) in path

    Port UUID

    bulk_disable
    boolean in query

    disable both ports

Enabling bonding

/ports/{id}/bond

Enabling bonding for one or all ports

  • Parameters
  • id
    string  (required) in path

    Port UUID

    bulk_enable
    boolean in query

    enable both ports

Convert to Layer 2

/ports/{id}/convert/layer-2

Converts a bond port to Layer 2. IP assignments of the port will be removed.

  • Parameters
  • id
    string  (required) in path

    Port UUID

    vnid
    in body

    Virtual Network ID

    {
    	"vnid": "string"
    } 

Convert to Layer 3

/ports/{id}/convert/layer-3

Converts a bond port to Layer 3. VLANs must first be unassigned.

  • Parameters
  • id
    string  (required) in path

    Port UUID

    request_ips
    in body

    IPs to request

    {
    	"request_ips": [
    		{
    			"address_family": "integer",
    			"public": "boolean"
    		}
    	]
    } 

Assign a native VLAN

/ports/{id}/native-vlan

Assigns a virtual network to this port as a "native VLAN"

  • Parameters
  • id
    string  (required) in path

    Port UUID

    vnid
    string  (required) in body

    UUID or VNID of the virtual network to assign

Remove native VLAN

/ports/{id}/native-vlan

Removes the native VLAN from this port

  • Parameters
  • id
    string  (required) in path

    Port UUID

Project Management

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

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, asn

    {
    	"deployment_type": "string",
    	"asn": "integer",
    	"md5": "string",
    	"use_case": "string"
    } 

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

Retrieve all BGP sessions for project

GET
/projects/{id}/bgp/sessions

Provides a listing of available BGP sessions for the project.

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

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

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

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

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.

The facilities attribute specifies in what datacenter you wish to create the device.

You can either specify a single facility { "facility": "f1" } , or you can instruct to create the device in the best available datacenter { "facility": "any" }. Additionally it is possible to set a prioritized location selection.

For example { "facility": ["f3", "f2", "any"] } will try to assign to the facility f3, if there are no available f2, and so on. If "any" is not specified for "facility", the request will fail unless it can assign in the selected locations.

The `ip_addresses attribute will allow you to specify the addresses you want created with your device.

To maintain backwards compatibility, If the attribute is not sent in the request, it will be treated as if { "ip_addresses": [{ "address_family": 4, "public": true }, { "address_family": 4, "public": false }, { "address_family": 6, "public": true }] } was sent.

The private IPv4 address is required and always need to be sent in the array. Not all operating systems support no public IPv4 address, so in those cases you will receive an error message.

For example, to only configure your server with a private IPv4 address, you can send { "ip_addresses": [{ "address_family": 4, "public": false }] }.

To access a server without public IPs, you can use our Out-of-Band console access (SOS) or use another server with public IPs as a proxy.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    device
     (required) in body

    Device to create

    facility, plan, operating_system

    {
    	"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",
    	"private_ipv4_subnet_size": "number",
    	"ip_addresses": [
    		{
    			"type": "object",
    			"address_family": "number",
    			"public": "boolean",
    			"cidr": "number"
    		}
    	]
    } 

Retrieve project invitations

GET
/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 Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Create an invitation for a project

/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

    {
    	"invitee": "string",
    	"message": "string",
    	"roles": [
    		"string"
    	],
    	"projects_ids": [
    		"string"
    	]
    } 

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

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, quantity

    {
    	"type": "string",
    	"quantity": "integer",
    	"comments": "string",
    	"facility": "string",
    	"customdata": "string"
    } 

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

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"
    } 

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

Provides the custom metadata stored for this project in json format

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

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

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

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

    {
    	"name": "string",
    	"payment_method_id": "string",
    	"customdata": "string"
    } 

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

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

    {
    	"name": "string",
    	"payment_method_id": "string",
    	"customdata": "string"
    } 

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

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"
    } 

Delete the project

/projects/{id}

Deletes the project.

  • Parameters
  • id
    string  (required) in path

    Project UUID

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"
    	]
    } 

List spot market requests

GET
/projects/{id}/spot-market-requests

View all spot market requests for a given project.

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

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"
    } 

Retrieve a device's ssk keys

GET
/devices/{id}/ssh-keys

Returns a collection of the device'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

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"
    } 

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

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"
    } 

Session Management

Destroy my current session.

Log in

/sessions

Log in.

  • Parameters
  • login
    string  (required) in query

    login

    password
    string  (required) in query

    password

Deletes a session specified by id.

  • Parameters
  • id
    string  (required) in path

    Session UUID

Returns all session tokens for the current user.

Spot Market Requests Management

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"
    	]
    } 

List spot market requests

GET
/projects/{id}/spot-market-requests

View all spot market requests for a given project.

Retrieve a spot market request

GET
/spot-market-requests/{id}

Returns a single spot market request

  • Parameters
  • id
    string  (required) in path

    SpotMarketRequest UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Delete the spot market request

/spot-market-requests/{id}

Deletes the spot market request.

  • Parameters
  • id
    string  (required) in path

    SpotMarketRequest UUID

    force_termination
    boolean in query

    Terminate associated spot instances

Manage SSH keys. See project endpoints to list and create project-level SSH keys.

Returns a collection of the user’s ssh keys.

  • Parameters
  • Search string
    string in query

    Search by key or label

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Creates a ssh key.

  • Parameters
  • ssh key
     (required) in body

    ssh key to create

    {
    	"label": "string",
    	"key": "string"
    } 

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

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"
    } 

Retrieve a device's ssk keys

GET
/devices/{id}/ssh-keys

Returns a collection of the device'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

Retrieve a ssh key

GET
/ssh-keys/{id}

Returns a single ssh key if the user has access

  • Parameters
  • id
    string  (required) in path

    SSH Key UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Update the ssh key

PUT
/ssh-keys/{id}

Updates the ssh key.

  • Parameters
  • id
    string  (required) in path

    SSH Key UUID

    ssh key
     (required) in body

    ssh key to update

    {
    	"label": "string",
    	"key": "string"
    } 

Delete the ssh key

/ssh-keys/{id}

Deletes the ssh key.

  • Parameters
  • id
    string  (required) in path

    ssh key UUID

Project Transfer Requests Management

Provides a collection of project transfer requests from or 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

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"
    } 

View a transfer request

GET
/transfers/{id}

Returns a single transfer request.

  • Parameters
  • id
    string  (required) in path

    Transfer request UUID

    include
    string in query

    related attributes to include

  •  
  • Response Body Show Hide
  • Request URL Show Hide
  • cURL Show Hide

Accept a transfer request

PUT
/transfers/{id}

Accept a transfer request.

  • Parameters
  • id
    string  (required) in path

    Transfer request UUID

Decline a transfer request.

  • Parameters
  • id
    string  (required) in path

    Transfer request UUID

Two Factor Authentication Management

Enables two factor authentication using authenticator app.