Skip to content
Equnix Metal
show

IP Addresses copied!

Manage IP addresses. See device and project endpoints to list and create IP assignments for a particular project or device. Check out the product docs to learn more about the basic networking features.

Retrieve an ip address copied!

GET
/ips/{id}

Returns a single ip address if the user has access.

  • Parameters
  • id
    string  (required) in path

    IP Address 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 an ip address copied!

PATCH
/ips/{id}

Update details about an ip address

  • Parameters
  • id
    string  (required) in path

    IP Address UUID

    details
    string  (required) in query

    Notes for this IP Assignment

    customdata
    string  (required) in query

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

Unassign an ip address copied!

DELETE
/ips/{id}

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

GET
/devices/{id}/ips

Returns all ip assignments for a device.

  • Parameters
  • id
    string  (required) in path

    Device 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

Create an ip assignment copied!

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

Retrieve all available subnets of a particular reservation copied!

GET
/ips/{id}/available

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 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 the custom metadata of an IP Reservation or IP Assignment copied!

GET
/ips/{id}/customdata

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

Retrieve all reservations copied!

GET
/projects/{project_id}/self-service/reservations

Returns all reservations.

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

POST
/projects/{project_id}/self-service/reservations

Creates a reservation.

  • Parameters
  • reservation
     (required) in body

    reservation to create

    {
    "start_date": "string",
    "period": {
        "properties": {
            "unit": {
                "type": "string",
                "enum": [
                    "monthly"
                ]
            },
            "count": {
                "type": "number",
                "enum": [
                    12,
                    36
                ]
            }
        }
    },
    "notes": "string",
    "item": [
        {
            "metro_id": "string",
            "plan_id": "string",
            "quantity": "integer",
            "amount": "number",
            "term": "string"
        }
    ]
}
    project_id
    string  (required) in path

    Project UUID

Retrieve a reservation copied!

GET
/projects/{project_id}/self-service/reservations/{id}

Returns a reservation

  • Parameters
  • id
    string  (required) in path

    Reservation short_id

    project_id
    string  (required) in path

    Project UUID

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