Route Aggregations

Create Route Aggregation

POST /fabric/v4/routeAggregations
Method POST
URL or Endpoint /fabric/v4/routeAggregations
Headers Authorization, Content-Type
Path Parameters Not applicable
Query Parameters Not applicable
Body Parameters type, name, description, project

Sample curl request

Copy 
curl -X POST 'https: //api.equinix.com/fabric/v4/routeAggregations'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "type": "BGP_IPv4_PREFIX_AGGREGATION",
    "name": "My-route-aggregation-v4",
    "description": "Test aggregation",
    "project": {
        "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
    }
}'

Body parameters

Parameter
Description
type string
REQUIRED
 Type.
Example: BGP_IPv4_PREFIX_AGGREGATION
name string
REQUIRED
 Name.
Example: My-direct-route-1
description string
OPTIONAL
 Description.
Example: My-direct-route-1
project object
REQUIRED
 Customer resource hierarchy project information.
Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId string
REQUIRED
Customer project identifier.
Example: 995072000433550

Sample response

Copy 
{
    "href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
    "type": "BGP_IPv4_PREFIX_AGGREGATION",
    "uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
    "name": "My-prefix-aggregation-v4",
    "description": "Test aggregation",
    "state": "PROVISIONING",
    "change": {
        "href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3",
        "type": "BGP_IPv4_PREFIX_AGGREGATION_CREATION",
        "uuid": "04af0d37-9160-43d8-97ef-9da9786996a3"
    },
    "rulesCount": 0,
    "connectionsCount": 0,
    "project": {
        "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
    },
    "changeLog": {
        "createdBy": "testuser",
        "createdByEmail": "testuser@equinix.com",
        "createdByFullName": "testuser testuser",
        "createdDateTime": "2020-05-21T10:30:00Z"
    }
}

Response description

Parameter
Description
href string
 An absolute URL that returns the specified asset.
Example:https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d
type string
 Asset instance type.
Example: BGP_IPv4_PREFIX_AGGREGATION.
uuid string
 Equinix-assigned asset identifier.
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d
name string
 Route Aggregation instance name.
Example: My-prefix-aggregation-v4
description string
 Route Aggregation description.
Example: Test aggregation
state string
 Asset lifecycle stage.
  • PROVISIONING - provisioning in progress.
  • PROVISIONED - provisioning done.
  • DEPROVISIONING - deprovisioning in progress.
  • DEPROVISIONED - deprovisioning done.
  • NOT_PROVISONED - provisioning is failed.
  • NOT_DEPROVISIONED - deprovisioning is failed.
change object
 Current state of latest Route Aggregation change.
uuid string
 Uniquely identifies a change.
Example: 04af0d37-9160-43d8-97ef-9da9786996a3
type string
 Type of change.
Example: BGP_IPv4_PREFIX_AGGREGATION_CREATION
href string
 Route Aggregation Change URI.
Example: https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3
connectionsCount integer
 Amount of connections.
Example: 0
rulesCount integer
 Amount of rules.
Example: 2
project object
 Customer resource hierarchy project information.
Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId string
 Customer project identifier.
Example: 995072000433550
changeLog object
 A permanent record of asset creation, modification, or deletion.
createdBy string
 Identity of the asset creator.
Example: AverageJoe
createdByFullName string
 First and last name of the asset creator.
Example: Joe Average
createdByEmail string
 Email address of the asset creator.
Example:joe@average.org
createdDateTime string
 Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z

 

Get Specified Route Aggregation

GET /fabric/v4/routeAggregations/{uuid}
Method GET
URL or Endpoint /fabric/v4/routeAggregations/{uuid}
Headers Authorization, Content-Type
Path Parameters uuid
Query Parameters Not applicable
Body Parameters Not applicable

Sample curl request

Copy 
curl -X GET 'https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter
Description
uuid string
REQUIRED		 Equinix-assigned Fabric Route Aggregations identifier.
Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62

If you get an "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric Portal access.


Sample response

Copy 
{
    "href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
    "type": "BGP_IPv4_PREFIX_AGGREGATION",
    "uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
    "name": "My-prefix-aggregation-v4",
    "description": "Test aggregation",
    "state": "PROVISIONING",
    "change": {
        "href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3",
        "type": "BGP_IPv4_PREFIX_AGGREGATION_CREATION",
        "uuid": "04af0d37-9160-43d8-97ef-9da9786996a3"
    },
    "rulesCount": 0,
    "connectionsCount": 0,
    "project": {
        "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
    },
    "changeLog": {
        "createdBy": "testuser",
        "createdByEmail": "testuser@equinix.com",
        "createdByFullName": "testuser testuser",
        "createdDateTime": "2020-05-21T10:30:00Z"
    }
}

Response payload body description

Parameter
Description
href string
 An absolute URL that returns the specified asset.
Example:https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d
type string
 Asset instance type.
Example: BGP_IPv4_PREFIX_AGGREGATION.
uuid string
 Equinix-assigned asset identifier.
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d
name string
 Route Aggregation instance name.
Example: My-prefix-aggregation-v4
description string
 Route Aggregation description.
Example: Test aggregation
state string
 Asset lifecycle stage.
  • PROVISIONING - provisioning in progress.
  • PROVISIONED - provisioning done.
  • DEPROVISIONING - deprovisioning in progress.
  • DEPROVISIONED - deprovisioning done.
  • NOT_PROVISONED - provisioning is failed.
  • NOT_DEPROVISIONED - deprovisioning is failed.
change object
 Current state of latest Route Aggregation change.
uuid string
 Uniquely identifies a change.
Example: 04af0d37-9160-43d8-97ef-9da9786996a3
type string
 Type of change.
Example: BGP_IPv4_PREFIX_AGGREGATION_CREATION
href string
 Route Aggregation Change URI.
Example: https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3
connectionsCount integer
 Amount of connections.
Example: 0
rulesCount integer
 Amount of rules.
Example: 2
project object
 Customer resource hierarchy project information.
Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId string
 Customer project identifier.
Example: 995072000433550
changeLog object
 A permanent record of asset creation, modification, or deletion.
createdBy string
 Identity of the asset creator.
Example: AverageJoe
createdByFullName string
 First and last name of the asset creator.
Example: Joe Average
createdByEmail string
 Email address of the asset creator.
Example:joe@average.org
createdDateTime string
 Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z

 

Update Route Aggregation

PATCH /fabric/v4/routeAggregations/{uuid}
Method PATCH
URL or Endpoint /fabric/v4/routeAggregations/{uuid}
Headers Authorization, Content-Type
Path Parameters uuid
Query Parameters Not applicable
Body Parameters op, path, value

Sample curl request

Copy 
curl -X PATCH 'https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '[
    {
        "op": "replace",
        "path": "/name",
        "value": "My-route-aggregation-v4-updated"
    }
]'

Path parameters

Parameter
Description
uuid string
REQUIRED		 Equinix-assigned Fabric Route Aggregationsr identifier.
Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62

Body parameters

Parameter
Description
op string
REQUIRED
 Update reqest type.
Applicable values:
  • replace
path string
REQUIRED
 Parameter path.
Applicable values:
  • /name
value string
REQUIRED
 New parameter value.
/name
value string
REQUIRED
 Fabric Route Aggregationsr instance name.
Example: myUpdatedInstance

If you get an "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric Portal access.


Sample response

Copy 
{
    "href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
    "type": "BGP_IPv4_PREFIX_AGGREGATION",
    "uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
    "name": "My-prefix-aggregation-v4-updated",
    "description": "Test aggregation",
    "state": "REPROVISIONING",
    "change": {
        "href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3",
        "type": "BGP_IPv4_PREFIX_AGGREGATION_UPDATE",
        "uuid": "04af0d37-9160-43d8-97ef-9da9786996a3"
    },
    "connectionsCount": 1,
    "rulesCount": 0,
    "project": {
        "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
    },
    "changeLog": {
        "createdBy": "testuser",
        "createdByEmail": "testuser@equinix.com",
        "createdByFullName": "testuser testuser",
        "createdDateTime": "2020-05-21T10:30:00Z"
    }
}

Response payload body description

Parameter
Description
href string
 An absolute URL that returns the specified asset.
Example:https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d
type string
 Asset instance type.
Example: BGP_IPv4_PREFIX_AGGREGATION.
uuid string
 Equinix-assigned asset identifier.
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d
name string
 Route Aggregation instance name.
Example: My-prefix-aggregation-v4
description string
 Route Aggregation description.
Example: Test aggregation
state string
 Asset lifecycle stage.
  • PROVISIONING - provisioning in progress.
  • PROVISIONED - provisioning done.
  • DEPROVISIONING - deprovisioning in progress.
  • DEPROVISIONED - deprovisioning done.
  • NOT_PROVISONED - provisioning is failed.
  • NOT_DEPROVISIONED - deprovisioning is failed
change object
 Current state of latest Route Aggregation change.
uuid string
 Uniquely identifies a change.
Example: 04af0d37-9160-43d8-97ef-9da9786996a3
type string
 Type of change.
Example: BGP_IPv4_PREFIX_AGGREGATION_CREATION
href string
 Route Aggregation Change URI.
Example: https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3
connectionsCount integer
 Amount of connections.
Example: 0
rulesCount integer
 Amount of rules.
Example: 2
project object
 Customer resource hierarchy project information.
Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId string
 Customer project identifier.
Example: 995072000433550
changeLog object
 A permanent record of asset creation, modification, or deletion.
createdBy string
 Identity of the asset creator.
Example: AverageJoe
createdByFullName string
 First and last name of the asset creator.
Example: Joe Average
createdByEmail string
 Email address of the asset creator.
Example:joe@average.org
createdDateTime string
 Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z

Delete Fabric Route Aggregation

DELETE /fabric/v4/routeAggregations/{uuid}
Method DELETE
URL or Endpoint /fabric/v4/routeAggregations/{uuid}
Headers Authorization, Content-Type
Path Parameters uuid
Query Parameters Not applicable
Body Parameters Not applicable

Sample curl request

Copy 
curl -X DELETE 'https://api.equinix.com/fabric/v4/routeAggregations/3a58dd05-f46d-4b1d-a154-2e85c396ea62'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter
Description
uuid string
REQUIRED		 Equinix-assigned Fabric Route Aggregations identifier.
Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62

Sample response

Copy 
{
  "href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
  "type": "BGP_IPv4_PREFIX_AGGREGATION",
  "uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
  "name": "My-prefix-aggregation-v4",
  "description": "Test Aggregation",
  "state": "DEPROVISIONING",
  "change": {
    "href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/c2ec84c5-6de6-4f5c-b506-3ce218630c31",
    "type": "BGP_IPv4_PREFIX_AGGREGATION_DELETION",
    "uuid": "c2ec84c5-6de6-4f5c-b506-3ce218630c31"
  },
  "connectionsCount": 0,
  "rulesCount": 0,
  "project": {
    "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
  },
  "changeLog": {
    "createdBy": "testuser",
    "createdByEmail": "testuser@equinix.com",
    "createdByFullName": "testuser testuser",
    "createdDateTime": "2020-05-21T10:30:00Z",
    "updatedBy": "testuser1",
    "updatedByEmail": "testuser@equinix.com",
    "updatedByFullName": "testuser testuser",
    "updatedDateTime": "2020-05-21T10:30:00Z",
    "deletedBy": "testuser1",
    "deletedByEmail": "testuser@equinix.com",
    "deletedByFullName": "testuser testuser",
    "deletedDateTime": "2020-05-21T10:30:00Z"
  }
}

Response payload body description

Parameter
Description
href string
 An absolute URL that returns the specified asset.
Example:https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d
type string
 Asset instance type.
Example: BGP_IPv4_PREFIX_AGGREGATION.
uuid string
 Equinix-assigned asset identifier.
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d
name string
 Route Aggregation instance name.
Example: My-prefix-aggregation-v4
description string
 Route Aggregation description.
Example: Test aggregation
state string
 Asset lifecycle stage.
  • PROVISIONING - provisioning in progress.
  • PROVISIONED - provisioning done.
  • DEPROVISIONING - deprovisioning in progress.
  • DEPROVISIONED - deprovisioning done.
  • NOT_PROVISONED - provisioning is failed.
  • NOT_DEPROVISIONED - deprovisioning is failed
change object
 Current state of latest Route Aggregation change.
uuid string
 Uniquely identifies a change.
Example: 04af0d37-9160-43d8-97ef-9da9786996a3
type string
 Type of change.
Example: BGP_IPv4_PREFIX_AGGREGATION_CREATION
href string
 Route Aggregation Change URI.
Example: https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3
connectionsCount integer
 Amount of connections.
Example: 0
rulesCount integer
 Amount of rules.
Example: 2
project object
 Customer resource hierarchy project information.
Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId string
 Customer project identifier.
Example: 995072000433550
changeLog object
 A permanent record of asset creation, modification, or deletion.
createdBy string
 Identity of the asset creator.
Example: AverageJoe
createdByFullName string
 First and last name of the asset creator.
Example: Joe Average
createdByEmail string
 Email address of the asset creator.
Example:joe@average.org
createdDateTime string
 Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z
updatedBy string
 Identity of the asset updater.
Example: AverageJoeUpdated
updatedByFullName string
 First and last name of the asset updater.
Example: Joe AverageUpdated
updatedByEmail string
 Email address of the asset updater.
Example:joeup@average.org
updatedDateTime string
 Asset update timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z
deletedBy string
 Identity of the asset remover.
Example: AverageJoe
deletedByFullName string
 First and last name of the asset remover.
Example: Joe Average
deletedByEmail string
 Email address of the asset remover.
Example:joeu@average.org
deletedDateTime string
 Asset delete timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z

If you get an "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric portal access.

Search Route Aggregations

POST /fabric/v4/routeAggregations/search
Method POST
URL or Endpoint /fabric/v4/routerAggregations/search
Headers Authorization, Content-Type
Path Parameters Not applicable
Query Parameters Not applicable
Body Parameters filter, pagination, sort

This API request retrieves Fabric Route Aggregations instances that match provided search criteria.

For instructions on how to obtain an authorization token, refer to Requesting Access and Refresh Tokens.


Sample curl request

Copy 
curl -X POST 'http: //api.equinix.com/fabric/v4/routeAggregations/search'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "filter": {
        "and": [
            {
                "property": "/type",
                "operator": "=",
                "values": [
                    "BGP_IPv4_PREFIX_AGGREGATION"
                ]
            },
            {
                "property": "/name",
                "operator": "like",
                "values": [
                    "%Route_Aggregation_Demo%"
                ]
            },
            {
                "property": "/project/projectId",
                "operator": "=",
                "values": [
                    "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
                ]
            }
        ]
    },
    "pagination": {
        "offset": 1,
        "limit": 2,
        "total": 10
    },
    "sort": [
        {
            "property": "/changeLog/updatedDateTime",
            "direction": "DESC"
        }
    ]
}'

Body parameters

Parameter
Description
filter string
REQUIRED
 Array of objects defining search conditions.
and array[object]
REQUIRED
 Logical operator applied on objects in the array.
property string
REQUIRED
 Search field parameter. Note that the property value determines the list of applicable operators and values.
Applicable values:
  • /name
  • /uuid
  • /state
  • /type
  • /project/projectId
operator string
REQUIRED
 Search field parameter operator.
Applicable values:
  • =
  • !=
  • >
  • >=
  • <
  • <=
  • BETWEEN
  • LIKE
  • IN
  • NOT BETWEEN
  • NOT LIKE
  • NOT IN
  • ~*
value array[string]
REQUIRED
 Search field parameter value.
pagination object
OPTIONAL
 Search results pagination settings.
offset integer
OPTIONAL
 Index of the first item returned in the response.
Minimum: 0
Default: 0
limit integer
OPTIONAL
 Maximum number of items returned per data page.
Minimum: 1
Default: 20
sort object
OPTIONAL
 Search results sorting settings.
direction string
OPTIONAL
 Search results sorting direction.
Applicable values:
  • ASC
  • DESC
property string
OPTIONAL
 Search results sorting parameter.
Applicable values:
  • /type
  • /name
  • /uuid
  • /state
  • /project/projectId
  • /connectionsCount
  • /changeLog/createdDateTime
  • /changeLog/updatedDateTime

Default value: /changeLog/updatedDateTime

Sample response

Copy 
{
    "pagination": {
        "offset": 1,
        "limit": 2,
        "total": 10,
        "next": "/routeAggregations?offset=3&limit=2",
        "previous": "/routeAggregations?offset=0&limit=2"
    },
    "data": [
        {
            "href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
            "type": "BGP_IPv4_PREFIX_AGGREGATION",
            "uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
            "name": "My_Route_Aggregation_Demo_1",
            "description": "Test aggregation",
            "state": "PROVISIONING",
            "connectionsCount": 1,
            "rulesCount": 0,
            "project": {
                "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
            },
            "changeLog": {
                "createdBy": "testuser",
                "createdByEmail": "testuser@equinix.com",
                "createdByFullName": "testuser testuser",
                "createdDateTime": "2020-05-21T10:30:00Z"
            }
        },
        {
            "href": "https://api.equinix.com/fabric/v4/routeAggregations/795a8471-6595-4ac6-a2f4-b3d96ed3a59d",
            "type": "BGP_IPv4_PREFIX_AGGREGATION",
            "uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
            "name": "My_Route_Aggregation_Demo_2",
            "description": "Test aggregation",
            "state": "PROVISIONING",
            "connectionsCount": 0,
            "rulesCount": 0,
            "project": {
                "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
            },
            "changeLog": {
                "createdBy": "testuser",
                "createdByEmail": "testuser@equinix.com",
                "createdByFullName": "testuser testuser",
                "createdDateTime": "2020-05-21T10:30:00Z"
            }
        }
    ]
}

Response payload body description

Parameter
Description
pagination object
 Search results pagination settings.
offset integer
 Index of the first item returned in the response.
Example: 0
limit integer
 Maximum number of items returned per page.
Example: 20
total integer
 Total number of items returned.
Example: 10
next string
 Next data page URL.
Example: /search?offset=40&limit=20
previous string
 Previous data page URL.
Example: /search?offset=0&limit=20
data array[object]
 Data array containing objects that match the provided search criteria.
href string
 An absolute URL that returns the specified asset.
Example:https://api.equinix.com/fabric/v4/routeAggregations/3a58dd05-f46d-4b1d-a154-2e85c396ea62
uuid string
 Equinix-assigned asset identifier.
Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
state string
 Asset lifecycle stage.
  • PROVISIONING - provisioning in progress.
  • PROVISIONED - provisioning done.
  • DEPROVISIONING - deprovisioning in progress.
  • DEPROVISIONED - deprovisioning done.
  • NOT_PROVISONED - provisioning is failed.
  • NOT_DEPROVISIONED - deprovisioning is failed.
type string
 Asset instance type.
Example: BGP_IPv4_PREFIX_AGGREGATION.
description string
 Description.
Example: Example desc.
name string
 Fabric Route Aggregations instance name.
Example: My-Fabric-Route-Aggr
project object
 Customer resource hierarchy project information.
Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId string
 Customer project identifier.
Example: 995072000433550
connectionCount integer
 Number of connections associated with this Fabric Router Aggregations instance.
Example: 0
rulesCount integer
 Number of rules associated with this Fabric Router Aggregations instance.
Example: 0
changeLog object
 A permanent record of asset creation, modification, or deletion.
createdBy string
 Identity of the asset creator.
Example: AverageJoe
createdByFullName string
 First and last name of the asset creator.
Example: Joe Average
createdByEmail string
 Email address of the asset creator.
Example:joe@average.org
createdDateTime string
 Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z

If you get an "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric Portal access.

 

Get All BGP Route Aggregations Changes

GET /fabric/v4/routeAggregations/{routeAggregationId}/changes
Method GET
URL or Endpoint /fabric/v4/routeAggregations/{routeAggregationId}/changes
Headers Authorization, Content-Type
Path Parameters routeAggregationId
Query Parameters offset, limit
Body Parameters Not applicable

Sample curl request

Copy 
curl -X GET 'https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Query parameters

Parameter
Description
offset integer
OPTIONAL		 Index of the first item returned in the response.
Minimum: 0
Default value: 0
limit integer
OPTIONAL		 Maximum number of items returned per page.
Minimum: 1
Maximum: 100
Default value: 20

If you get an "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric Portal access.


Sample response

Copy 
{
  "pagination": {
    "offset": 0,
    "limit": 20,
    "total": 4,
    "next": null,
    "previous": null
  },
  "data": [
    {
      "href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3",
      "type": "BGP_IPv4_PREFIX_AGGREGATION_CREATION",
      "uuid": "04af0d37-9160-43d8-97ef-9da9786996a3",
      "status": "COMPLETED",
      "createdBy": "testuser",
      "createdByEmail": "testuser@equinix.com",
      "createdByFullName": "testuser testuser",
      "createdDateTime": "2020-05-21T10:30:00Z",
      "updatedBy": "_system",
      "updatedByEmail": null,
      "updatedByFullName": null,
      "updatedDateTime": "2020-05-21T10:30:00Z",
      "data": {
        "type": "BGP_IPv4_PREFIX_AGGREGATION",
        "name": "My-route-aggregation-v4",
        "description": "Test Aggregation",
        "project": {
          "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
        }
      }
    },
    {
      "href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3",
      "type": "BGP_IPv4_PREFIX_AGGREGATION_UPDATE",
      "uuid": "04af0d37-9160-43d8-97ef-9da9786996a3",
      "status": "COMPLETED",
      "createdBy": "testuser",
      "createdByEmail": "testuser@equinix.com",
      "createdByFullName": "testuser testuser",
      "createdDateTime": "2020-05-21T10:30:00Z",
      "updatedBy": "_system",
      "updatedByEmail": null,
      "updatedByFullName": null,
      "updatedDateTime": "2020-05-21T10:30:00Z",
      "data": [
        {
          "op": "replace",
          "path": "/name",
          "value": "My-route-aggregations-v4-updated",
          "previousValue": "My-route-aggregations-v4"
        }
      ]
    }
  ]
}

Response payload body description

Parameter
Description
pagination object Data set pagination information.
offset integer
 Index of the first item returned in the response.
Example: 0
limit integer
 Maximum number of items returned per page.
Example: 20
total integer
 Total number of items returned.
Example: 123
data array[object] Data set containing Fabric Route Aggregations packages.
href string
 An absolute URL that returns the specified asset.
Example:https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3
type string
 Type of change.
Example: BGP_IPv4_PREFIX_AGGREGATION_UPDATE
status string
 Current outcome of the change flow.
Example: COMPLETED
uuid string
 Equinix-assigned asset identifier.
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d
createdBy string
 Created by
Example: user_1
createdDateTime string
 Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z
updatedBy string
 Updated by
Example: user_2
updatedDateTime string
 Asset modification timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15611:12:29.526Z
description string
 Additional description.
data array[object]
 Route Aggregation change operation data.
op string
 Handy shortcut for operation name.
Example: add
path string
 Path inside document leading to updated parameter.
Example: /name
value string
 Value
Example: add


Get Specific BGP Route Aggregations Changes

GET /fabric/v4/routeAggregations/{routeAggregationId}/changes/{changeId}
Method GET
URL or Endpoint /fabric/v4/routeAggregations/{routeAggregationId}/changes/{changeId}
Headers Authorization, Content-Type
Path Parameters routeAggregationId, changeId
Query Parameters Not applicable
Body Parameters Not applicable

Sample curl request

Copy 
curl -X GET 'https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter
Description
routeAggregationId string
REQUIRED		 Route Aggregations Id.
Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
changeId string
REQUIRED		 Routing Protocol Change UUID.
Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62

If you get an "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric Portal access.


Sample response

Copy 
{
  "href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3",
  "type": "BGP_IPv4_PREFIX_AGGREGATION_CREATION",
  "uuid": "04af0d37-9160-43d8-97ef-9da9786996a3",
  "status": "COMPLETED",
  "createdBy": "testuser",
  "createdByEmail": "testuser@equinix.com",
  "createdByFullName": "testuser testuser",
  "createdDateTime": "2020-05-21T10:30:00Z",
  "updatedBy": "_system",
  "updatedByEmail": null,
  "updatedByFullName": null,
  "updatedDateTime": "2020-05-21T10:30:00Z",
  "data": {
    "type": "BGP_IPv4_PREFIX_AGGREGATION",
    "name": "My-route-aggregation-v4",
    "description": "Test aggregation",
    "project": {
      "projectId": "dadd3ab6-c0af-430c-8216-43d44f08c1c5"
    }
  }
}

Response payload body description

Parameter
Description
href string
 An absolute URL that returns the specified asset.
Example:https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3
type string
 Asset instance type.
Example: BGP_IPv4_PREFIX_AGGREGATION.
uuid string
 Equinix-assigned asset identifier.
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d
status string
 Current outcome of the change flow.
Example: COMPLETED
createdBy string
 Identity of the asset creator.
Example: AverageJoe
createdByEmail string
 Email address of the asset creator.
Example:joe@average.org
createdByFullName string
 First and last name of the asset creator.
Example: Joe Average
createdDateTime string
 Asset creation timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z
updatedBy string
 Identity of the asset updater.
Example: AverageJoe
updatedByEmail string
 Email address of the asset updater.
Example:joe@average.org
updatedByFullName string
 First and last name of the asset updater.
Example: Joe Average
updatedDateTime string
 Asset updater timestamp in the IETF ISO 8601 extended date/time format: YYYY-MM-DDTHH:MM:SS.000+0000
Example: 2021-07-15T19:30:29.526Z
data array[object]
 Route Aggregation change operation data.
type string
 Route Aggregation type.
Example: BGP_IPv4_PREFIX_AGGREGATION
name string
 Operation name.
Example: Aggregate new name
description string
 Change description.
Example: New description
project object
 Customer resource hierarchy project information.
Applicable to customers onboarded to Equinix Identity and Access Management. For more information see Identity and Access Management: Projects.
projectId string
 Customer project identifier.
Example: 995072000433550

 

Get All Connections using a Specific Route Aggregation

GET /fabric/v4/routeAggregations/{routeAggregationId}/connections
Method GET
URL or Endpoint /fabric/v4/routeAggregations/{routeAggregationId}/connections
Headers Authorization, Content-Type
Path Parameters routeAggregationId
Query Parameters Not applicable
Body Parameters Not applicable

Sample curl request

Copy 
curl -X GET 'https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/connections'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

If you get an "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric Portal access.


Sample response

Copy 
{
  "pagination": {
    "offset": 0,
    "limit": 20,
    "total": 1,
    "next": null,
    "previous": null
  },
  "data": {
    "href": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f",
    "type": "IP_VC",
    "name": "test-connection",
    "uuid": "05de355a-6c9d-4636-8d7d-7b7595821c15"
  }
}

Response payload body description

Parameter
Description
pagination object Data set pagination information.
offset integer
 Index of the first item returned in the response.
Example: 0
limit integer
 Maximum number of items returned per page.
Example: 20
total integer
 Total number of items returned.
Example: 123
data array[object] Data set containing Fabric Route Aggregations packages.
href string
 An absolute URL that returns the specified connection.
Example:https://api.equinix.com/fabric/v4/connections/695a8471-6595-4ac6-a2f4-b3d96ed3a59d
type string
 Connection type.
Example: IP_VC
name string
 Connection name.
Example: COMPLETED
uuid string
 Equinix-assigned asset identifier.
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

 

Get Route Aggregations attached to a Connection

GET /fabric/v4/connections/{connectionId}/routeAggregations
Method GET
URL or Endpoint /fabric/v4/connections/{connectionId}/routeAggregations
Headers Authorization, Content-Type
Path Parameters connectionId
Query Parameters Not applicable
Body Parameters Not applicable

Sample curl request

Copy 
curl -X GET 'https://api.equinix.com/fabric/v4/connections/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregations'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

If you get an "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric Portal access.


Sample response

Copy 
{
  "href": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
  "type": "BGP_IPv4_PREFIX_AGGREGATION",
  "uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
  "attachmentStatus": "ATTACHED"
}

Response payload body description

Parameter
Description
href string
 An absolute URL that returns the specified route aggregations.
Example:https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d
type string
 Route Aggregation type.
Example: BGP_IPv4_PREFIX_AGGREGATION
attachmentStatus string
 Status.
Example: ATTACHED
uuid string
 Equinix-assigned asset identifier.
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

 

Attach Route Aggregation to a Connection

PUT /fabric/v4/connections/{connectionId}/routeAggregations/{routeAggregationId}
Method PUT
URL or Endpoint /fabric/v4/connections/{connectionId}/routeAggregations/{routeAggregationId}
Headers Authorization, Content-Type
Path Parameters connectionId, routeAggregationId
Query Parameters Not applicable
Body Parameters Not applicable

Sample curl request

Copy 
curl -X PUT 'https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

If you get an "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric Portal access.


Sample response

Copy 
{
  "href": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
  "type": "BGP_IPv4_PREFIX_AGGREGATION",
  "uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
  "attachmentStatus": "ATTACHING"
}

Response payload body description

Parameter
Description
href string
 An absolute URL that returns the specified route aggregations.
Example:https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d
type string
 Route Aggregation type.
Example: BGP_IPv4_PREFIX_AGGREGATION
attachmentStatus string
 Status.
Example: ATTACHING
uuid string
 Equinix-assigned asset identifier.
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

 

Delete a Route Aggregation to a Connection

DELETE /fabric/v4/connections/{connectionId}/routeAggregations/{routeAggregationId}
Method DELETE
URL or Endpoint /fabric/v4/connections/{connectionId}/routeAggregations/{routeAggregationId}
Headers Authorization, Content-Type
Path Parameters connectionId, routeAggregationId
Query Parameters Not applicable
Body Parameters Not applicable

Sample curl request

Copy 
curl -X DELETE 'https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

If you get an "Access Denied" error, contact your local Equinix Service Desk for Equinix Fabric Portal access.


Sample response

Copy 
{
  "href": "https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
  "type": "BGP_IPv4_PREFIX_AGGREGATION",
  "uuid": "695a8471-6595-4ac6-a2f4-b3d96ed3a59d",
  "attachmentStatus": "DETACHING"
}

Response payload body description

Parameter
Description
href string
 An absolute URL that returns the specified route aggregations.
Example:https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d
type string
 Route Aggregation type.
Example: BGP_IPv4_PREFIX_AGGREGATION
attachmentStatus string
 Status.
Example: DETACHING
uuid string
 Equinix-assigned asset identifier.
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d