Skip to content
Equnix Metal
show

Connections copied!

Network Interconnections. See Instructions to create Network Interconnections at Check out the product docs to learn more about Equinix Fabric.

Retrieve connection events copied!

GET
/connections/{connection_id}/events

Returns a list of the connection events

  • Parameters
  • connection_id
    string  (required) in path

    Connection 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 connection port events copied!

GET
/connections/{connection_id}/ports/{id}/events

Returns a list of the connection port events

  • Parameters
  • connection_id
    string  (required) in path

    Connection UUID

    id
    string  (required) in path

    Connection Port 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 connection events copied!

GET
/virtual-circuit/{id}/events

Returns a list of the virtual circuit events

  • Parameters
  • id
    string  (required) in path

    Virtual Circuit 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

Request a new connection for the organization copied!

POST
/organizations/{organization_id}/connections

Creates a new connection request. A Project ID must be specified in the request body for connections on shared ports.

  • Parameters
  • organization_id
    string  (required) in path

    UUID of the organization

    connection
     (required) in body

    Connection details

    name, facility, type, redundancy

    {
        "name": "string",
        "description": "string",
        "facility": "string",
        "metro": "string",
        "type": "string",
        "redundancy": "string",
        "contact_email": "string",
        "project": "string",
        "speed": "string",
        "tags": [
            "string"
        ]
    }

List organization connections copied!

GET
/organizations/{organization_id}/connections

List the connections belonging to the organization

Request a new connection for the project's organization copied!

POST
/projects/{project_id}/connections

Creates a new connection request

  • Parameters
  • project_id
    string  (required) in path

    UUID of the project

    connection
     (required) in body

    Connection details

    name, facility, type, redundancy

    {
        "name": "string",
        "description": "string",
        "facility": "string",
        "metro": "string",
        "type": "string",
        "redundancy": "string",
        "contact_email": "string",
        "project": "string",
        "speed": "string",
        "tags": [
            "string"
        ]
    }

List project connections copied!

GET
/projects/{project_id}/connections

List the connections belonging to the project

Get connection copied!

GET
/connections/{connection_id}

Get the details of a connection

Update connection copied!

PUT
/connections/{connection_id}

Update the details of a connection

  • Parameters
  • connection_id
    string  (required) in path

    Connection UUID

    connection
     (required) in body

    Updated connection details

    {
        "name": "string",
        "redundancy": "string",
        "description": "string",
        "contact_email": "string",
        "tags": [
            "string"
        ]
    }

Delete connection copied!

DELETE
/connections/{connection_id}

Delete a connection, its associated ports and virtual circuits.

  • Parameters
  • connection_id
    string  (required) in path

    Connection UUID

List a connection's ports copied!

GET
/connections/{connection_id}/ports

List the ports associated to an connection.

Get a connection port copied!

GET
/connections/{connection_id}/ports/{id}

Get the details of an connection port.

  • Parameters
  • connection_id
    string  (required) in path

    UUID of the connection

    id
    string  (required) in path

    Port UUID

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

List a connection port's virtual circuits copied!

GET
/connections/{connection_id}/ports/{port_id}/virtual-circuits

List the virtual circuit record(s) associatiated with a particular connection port.

  • Parameters
  • connection_id
    string  (required) in path

    UUID of the connection

    port_id
    string  (required) in path

    UUID of the connection port

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

Create a new Virtual Circuit copied!

POST
/connections/{connection_id}/ports/{port_id}/virtual-circuits

Create a new Virtual Circuit on a dedicated connection using a Virtual Network record and an NNI VLAN value.

  • Parameters
  • connection_id
    string  (required) in path

    UUID of the connection

    port_id
    string  (required) in path

    UUID of the connection port

    virtual_circuit
     (required) in body

    Virtual Circuit details

    {
        "description": "string",
        "name": "string",
        "speed": "integer",
        "tags": [
            "string"
        ],
        "vnid": "string",
        "nni_vlan": "integer",
        "project": "string"
    }

Get a virtual circuit copied!

GET
/virtual-circuits/{id}

Get the details of a virtual circuit

Update a virtual circuit copied!

PUT
/virtual-circuits/{id}

Update the details of a virtual circuit.

  • Parameters
  • id
    string  (required) in path

    Virtual Circuit UUID

    virtual_circuit
     (required) in body

    Updated Virtual Circuit details

    {
        "description": "string",
        "name": "string",
        "speed": "string",
        "tags": [
            "string"
        ],
        "vnid": "string"
    }

Delete a virtual circuit copied!

DELETE
/virtual-circuits/{id}

Delete a virtual circuit from a dedicated port.

  • Parameters
  • id
    string  (required) in path

    Virtual Circuit UUID