Skip to content
Equnix Metal
show

Projects copied!

Project Management. Check out the product docs to learn more about Projects.

Retrieve all batches by project copied!

GET
/projects/{id}/batches

Returns all batches for the given project

  • Parameters
  • id
    string  (required) in path

    Project UUID

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

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

Requesting bgp config copied!

POST
/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 copied!

GET
/projects/{id}/bgp-config

Returns a bgp config

  • Parameters
  • id
    string  (required) in path

    Project UUID

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

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

Retrieve all BGP sessions for project copied!

GET
/projects/{id}/bgp/sessions

Provides a listing of available BGP sessions for the project.

Retrieve project's events copied!

GET
/projects/{id}/events

Returns a list of events for a single project

  • Parameters
  • id
    string  (required) in path

    Project UUID

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

    page
    integer in query  (minimum: 1)  (maximum: 100000)

    Page to return

    Default: 1

    per_page
    integer in query  (minimum: 1)  (maximum: 1000)

    Items returned per page

    Default: 10

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

Retrieve all facilities visible by the project copied!

GET
/projects/{id}/facilities

Returns a listing of available datacenters for the given project

  • Parameters
  • id
    string  (required) in path

    Project UUID

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

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

Retrieve all global bgp ranges copied!

GET
/projects/{id}/global-bgp-ranges

Returns all global bgp ranges for a project

Retrieve all hardware reservations for a given project copied!

GET
/projects/{id}/hardware-reservations

Provides a collection of hardware reservations for a given project.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

    page
    integer in query  (minimum: 1)  (maximum: 100000)

    Page to return

    Default: 1

    per_page
    integer in query  (minimum: 1)  (maximum: 1000)

    Items returned per page

    Default: 10

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

Retrieve all devices of a project copied!

GET
/projects/{id}/devices

Provides a collection of devices for a given project.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

    page
    integer in query  (minimum: 1)  (maximum: 100000)

    Page to return

    Default: 1

    per_page
    integer in query  (minimum: 1)  (maximum: 1000)

    Items returned per page

    Default: 10

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

Create a device copied!

POST
/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`.
  • 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": "object",
    "metro": "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"
    ],
    "ssh_keys": [
        {
            "label": "string",
            "key": "string"
        }
    ],
    "no_ssh_keys": "boolean",
    "features": [
        "string"
    ],
    "public_ipv4_subnet_size": "number",
    "private_ipv4_subnet_size": "number",
    "ip_addresses": [
        {
            "type": "object",
            "address_family": "number",
            "public": "boolean",
            "cidr": "number",
            "ip_reservations": "array"
        }
    ]
}

Retrieve project invitations copied!

GET
/projects/{project_id}/invitations

Returns all invitations in a project.

  • Parameters
  • include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

    page
    integer in query  (minimum: 1)  (maximum: 100000)

    Page to return

    Default: 1

    per_page
    integer in query  (minimum: 1)  (maximum: 1000)

    Items returned per page

    Default: 10

    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 copied!

POST
/projects/{project_id}/invitations

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

  • Parameters
  • project_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 copied!

GET
/projects/{id}/ips

Provides a list of IP resevations for a single project.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

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

Requesting IP reservations copied!

POST
/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.

  • 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",
    "metro": "string",
    "customdata": "object",
    "tags": [
        "string"
    ],
    "details": "string",
    "fail_on_approval_required": "boolean"
}

Retrieve all licenses copied!

GET
/projects/{id}/licenses

Provides a collection of licenses for a given project.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

    page
    integer in query  (minimum: 1)  (maximum: 100000)

    Page to return

    Default: 1

    per_page
    integer in query  (minimum: 1)  (maximum: 1000)

    Items returned per page

    Default: 10

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

Create a License copied!

POST
/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 copied!

GET
/projects/{project_id}/memberships

Returns all memberships in a project.

  • Parameters
  • include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

    page
    integer in query  (minimum: 1)  (maximum: 100000)

    Page to return

    Default: 1

    per_page
    integer in query  (minimum: 1)  (maximum: 1000)

    Items returned per page

    Default: 10

    project_id
    string  (required) in path

    Project UUID

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

Retrieve the custom metadata of a project copied!

GET
/projects/{id}/customdata

Provides the custom metadata stored for this project in json format

Retrieve the custom metadata of an IP Reservation copied!

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

Retrieve all plans visible by the project copied!

GET
/projects/{id}/plans

Returns a listing of available plans for the given project

  • Parameters
  • id
    string  (required) in path

    Project UUID

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

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

Retrieve all projects of an organization copied!

GET
/organizations/{id}/projects

Returns a collection of projects that belong to the organization.

  • Parameters
  • id
    string  (required) in path

    Organization UUID

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

    page
    integer in query  (minimum: 1)  (maximum: 100000)

    Page to return

    Default: 1

    per_page
    integer in query  (minimum: 1)  (maximum: 1000)

    Items returned per page

    Default: 10

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

Create a project for the organization copied!

POST
/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": "object"
}

Retrieve all projects copied!

GET
/projects

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

  • Parameters
  • include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

    page
    integer in query  (minimum: 1)  (maximum: 100000)

    Page to return

    Default: 1

    per_page
    integer in query  (minimum: 1)  (maximum: 1000)

    Items returned per page

    Default: 10

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

Create a project copied!

POST
/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

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

Retrieve a project copied!

GET
/projects/{id}

Returns a single project if the user has access

  • Parameters
  • id
    string  (required) in path

    Project UUID

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

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

Update the project copied!

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

Delete the project copied!

DELETE
/projects/{id}

Deletes the project.

  • Parameters
  • id
    string  (required) in path

    Project UUID

Create a spot market request copied!

POST
/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"
    ],
    "metro": "string"
}

List spot market requests copied!

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

View all spot market requests for a given project.

Retrieve a project's ssh keys copied!

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 by key, label, or fingerprint

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

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

Create a ssh key for the given project copied!

POST
/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",
    "instances_ids": [
        "string"
    ]
}

Retrieve a device's ssh keys copied!

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 by key, label, or fingerprint

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

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

Create a transfer request copied!

POST
/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 copied!

GET
/projects/{id}/virtual-networks

Provides a list of virtual networks for a single project.

  • Parameters
  • id
    string  (required) in path

    Project UUID

    include
    array in query

    Nested attributes to include. Included objects will return their full attributes. Attribute names can be dotted (up to 3 levels) to included deeply nested objects.

    exclude
    array in query

    Nested attributes to exclude. Excluded objects will return only the href attribute. Attribute names can be dotted (up to 3 levels) to exclude deeply nested objects.

    facility
    string in query

    Filter by Facility ID (uuid) or Facility Code

    metro
    string in query

    Filter by Metro ID (uuid) or Metro Code

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

Create a virtual network copied!

POST
/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

    {
    "project_id": "string",
    "description": "string",
    "facility": "string",
    "metro": "string",
    "vxlan": "integer"
}