Equnix Metal
Loading...

Facilities

COMMAND LINE

Copy to clipboard

Facilities

A Facility is a single, physical data center location within a Metro. Most Equinix Metal™ user experiences and features are focused around Metros, however sometimes it may be useful to dig down and know a little bit about your servers at the Facility level.

Which Facility is my Server in?

In the Equinix Metal console, you can see which facility your server lives in from the Servers tab on a Project. The Location column will show location information in metro - facility format.

Server's Location Field

If a server was not provisioned from a Metro, the location will be shown with just the facility information.

In the API, the response to a GET request to the devices/{id} endpoint includes a facilities object.

curl -X GET -H 'X-Auth-Token: <API_TOKEN>' https://api.equinix.com/metal/v1/devices/{id}

Sample Response:

{
"id": "0dd71771-143e-4964-87d2-7e6e0348253f",
...
"facility": {
    "id": "2b70eb8f-fa18-47c0-aba7-222a842362fd",
    "name": "Sunnyvale, CA",
    "code": "sjc1",
    "features": [
      "baremetal",
      "storage",
      "layer_2",
      "global_ipv4",
      "backend_transfer"
    ],
    "address": {
      "href": "#9dba11a6-0a26-4993-901b-df253713b89e"
    },
    "metro": {
      "id": "2991b022-b8c4-497e-8db7-5a407c3a209b",
      "name": "Silicon Valley",
      "code": "sv"
    },
    "ip_ranges": [
      "2604:1380:1000::/36",
      "147.75.200.0/22",
      "147.75.108.0/22",
      "147.75.68.0/22",
      "147.75.88.0/22"
    ]
},
...
}

Facilities Quick Reference

Note: In the API, the facility code is case-sensitive.

Core Sites

Core metros have servers available for provisioning On-Demand, through the Spot Market, and through ordering Reserved Hardware.

Region Metro Code Facilities
AMER Washington DC DC dc13, iad1, iad2
AMER Dallas DA da11, dfw2, dfw1
AMER Silicon Valley SV sv15, sjc1
EMEA Amsterdam AM am6, ams1
EMEA Frankfurt FR fr2, fra2
APAC Singapore SG sg1, sin2, sin3, sin1
APAC Sydney SY sy4, syd2

Expansion Sites

Expansion metros have servers that are only available through a Hardware Reservation.

Region Metro Code Facilities
AMER Chicago CH ch3, ord1, ord4
AMER New York NY ny5, ny7, ewr1
AMER Los Angeles LA la4, lax1, lax2
AMER Toronto TR tr2
EMEA London LD ld7
EMEA Madrid MD md2
APAC Hong Kong HK hk2, hkg2
APAC Seoul SL sl1
APAC Tokyo TY nrt1

Legacy Facility Sites

Equinix Metal has a number of legacy facilities that are located in metros along side Equinix IBX facilities, and your infrastructure in a metro can span across both types of facilities. For a few Equinix Metal features, you may need to know whether your server is in a legacy facility or an Equinix IBX for configuration purposes. The table lists the legacy facilities and their metros.

Core Sites

Region Metro Code Facilities
AMER Washington DC DC iad1, iad2
AMER Dallas DA dfw2, dfw1
AMER Silicon Valley SV sjc1
EMEA Amsterdam AM ams1
EMEA Frankfurt FR fra2
APAC Singapore SG sin2, sin3, sin1
APAC Sydney SY syd2

Expansion Sites

Region Metro Code Facilities
AMER Chicago CH ord1, ord4
AMER New York NY ewr1
AMER Los Angeles LA lax1, lax2
APAC Hong Kong HK hkg2
APAC Tokyo TY nrt1

Equinix Metal also maintains a number of global legacy sites that are no longer adding new capacity or getting new hardware. Not all of these facilities are visible to every organization or user. Please contact us with details about your deployment or application needs if you have questions about these facilities.

Region Metro Code Facilities
AMER Atlanta AT atl1, atl2
AMER Seattle SE sea1, sea2
AMER Detroit DT dtw1
AMER Houston HO iah1
AMER Toronto - Legacy YYZ yyz1
AMER Kansas City KC mci1
AMER Phoenix PX phx1
AMER Pittsburgh PI pit1
EMEA Marseille MR mrs1

API Endpoints

Information about individual facilities is available from the /facilities endpoint.

Sending a GET request to the /facilities endpoint will return a list of data centers where your user account is able to provision with lots of information about each, including name, code, ID. The features listed are available to servers in those data centers.

curl -X GET -H 'X-Auth-Token: <API_TOKEN>' https://api.equinix.com/metal/v1/facilities

Sending a GET request to the /projects/{id}/facilities endpoint, where the id is the Project ID, will return a list of data centers that are available to that project.

curl -X GET -H 'X-Auth-Token: <API_TOKEN>' https://api.equinix.com/metal/v1/projects/{id}/facilities

And sending a GET request to the /organizations/{id}/facilities endpoint, where the id is the Organization ID, will return a list servers that available to your organization.

curl -X GET -H 'X-Auth-Token: <API_TOKEN>' https://api.equinix.com/metal/v1/organizations/{id}/facilities

Provisioning in a Specific Facility

If your use-case requires that you provision your servers in a specific facility, you can do so using the API.

When you send the provisioning POST request projects/{id}/devices endpoint, use the "facility" field with the facility_code where you want the server to live instead of specifying a Metro.

curl -X POST \
-H "Content-Type: application/json" \
-H "X-Auth-Token: <API_TOKEN>" \
"https://api.equinix.com/metal/v1/projects/{id}/devices" \
-d '{
    "facility": "<facility_code>",
    "plan": "<server_type>",
    "operating_system": "<os_code>"
}'

Being able to provision in a specific facility API also allows automations that uses our integrations, like the Terraform provider, also support provisioning in specific facilities.

Using Facilities in Place of Metros

Similar to provisioning on-demand servers, other deployment options and platform features can use facilities in place of metros in the API.

Be aware, the use of the "facilites" parameter is mutually exclusive to the "metros" parameter; it is not possible to use both.

Facility Capacity

Data center logistics and variations in demand can sometimes result in inventory fluctuations. When you deploy from the console, in a Metro, your options are automatically filtered and you can take advantage of the capacity across the whole Metro. If you are deploying servers through the API to a specific facility, that filtering is not available, and if there isn't enough capacity to provision your order, the request will fail.

To check the capacity of facilities, use the /capacity endpoint. Send a GET request to see a complete list of data centers, servers, and their capacity levels.

curl -X GET -H 'X-Auth-Token: <API_TOKEN>' https://api.equinix.com/metal/v1/capacity

Capacity responses are one of the following:

  • Normal - There are plenty of servers available.
  • Limited - There are servers available, but the stock is limited.
  • Unavailable - Servers of a particular type and data center combination are not available.

Instead of checking capacity for everything at once, you can also check to see if a request for a specific facility and server will be able to be filled. Send a POST request to the /capacity endpoint with the facility, server type, and number of servers you need in the body of the request.

curl -X POST \
-H "Content-Type: application/json" \
-H "X-Auth-Token: <API_TOKEN>" \
"https://api.equinix.com/metal/v1/capacity" \
-d '{
    "servers": [
        {
            "facility": "<facility_code>",
            "plan": "<server_type>",
            "quantity": <number_of_servers>
        }
    ]
}'

If the request will succeed, the servers object will contain an additional field "available":true in the response. If the request will fail, the servers object will contain an additional field "available":false in the response.

Frequently
asked questions

Slack

Still stuck?

Join us on Slack

Get support from our team and community members.

Frequently asked questions

What 3rd party Managed Services?

Neutra trust fund narwhal, palo santo bicycle rights live-edge stumptown health goth portland selfies kinfolk woke. ssss Echo park irony artisan vaporware typewriter. Next level pinterest drinking vinegar lyft mumblecore af small batch heirloom VHS. Fixie banh mi asymmetrical trust fund.

What 3rd party Managed Services?

Neutra trust fund narwhal, palo santo bicycle rights live-edge stumptown health goth portland selfies kinfolk woke. ssss Echo park irony artisan vaporware typewriter. Next level pinterest drinking vinegar lyft mumblecore af small batch heirloom VHS. Fixie banh mi asymmetrical trust fund.

What 3rd party Managed Services?

Neutra trust fund narwhal, palo santo bicycle rights live-edge stumptown health goth portland selfies kinfolk woke. ssss Echo park irony artisan vaporware typewriter. Next level pinterest drinking vinegar lyft mumblecore af small batch heirloom VHS. Fixie banh mi asymmetrical trust fund.

Copied code to clipboard