Route Aggregation Rules

Create Route Aggregation Rule

POST /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules
Method POST
URL or Endpoint /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules
Headers Authorization, Content-Type
Path Parameters routeAggregationId
Query Parameters Not applicable
Body Parameters name, description, prefix

Path parameters

Parameter
Description
routeAggregationId string
REQUIRED		 Equinix-assigned Fabric Route Aggregations identifier.
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

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

Sample curl request

Copy 
curl -X POST 'https: //api.equinix.com/fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
  "name": "Private-subnet-aggregation",
  "description": "Test rule",
  "prefix": "192.168.0.0/24"
}'

Body parameters

Parameter
Description
prefix string
REQUIRED
 Prefix.
Example: 192.168.0.0/24
name string
OPTIONAL
 Name.
Example: Private-subnet-aggregation
description string
OPTIONAL
 Description.
Example: test rule

Sample response

Copy 
{
  "href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403",
  "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE",
  "uuid": "9890d520-1579-4489-8003-154b34b8f403",
  "name": "Private-subnet-aggregation",
  "state": "PROVISIONING",
  "description": "Test rule",
  "change": {
    "href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403/changes/ff9653dc-88c5-47b5-b552-8a08d2f73f7e",
    "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE_CREATION",
    "uuid": "ff9653dc-88c5-47b5-b552-8a08d2f73f7e"
  },
  "prefix": "192.168.0.0/24",
  "changeLog": {
    "createdBy": "testuser",
    "createdByEmail": "testuser@equinix.com",
    "createdByFullName": "testuser testuser",
    "createdDateTime": "2020-05-21T10:30:00Z",
    "updatedBy": "testuser",
    "updatedByEmail": "testuser@equinix.com",
    "updatedByFullName": "testuser testuser",
    "updatedDateTime": "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/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403
type string
 Asset instance type.
Example: BGP_IPv4_PREFIX_AGGREGATION_RULE.
uuid string
 Equinix-assigned asset identifier.
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d
name string
 Route Aggregation Rules name.
Example: My-prefix-aggregation-v4
description string
 Route Aggregation Rules description.
Example: Test aggregation rule
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 Rules change.
uuid string
 Uniquely identifies a change.
Example: 04af0d37-9160-43d8-97ef-9da9786996a3
type string
 Type of change.
Example: BGP_IPv4_PREFIX_RULE_AGGREGATION_CREATION
href string
 Route Aggregation Rules Change URI.
Example: https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403/changes/ff9653dc-88c5-47b5-b552-8a08d2f73f7e
prefix string
 Prefix.
Example: 192.168.0.0/24
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: AverageJoeUp
updatedByFullName string
 First and last name of the asset updater.
Example: Joe Average Up
updatedByEmail string
 Email address of the asset updater.
Example:joe@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

 

Create Route Aggregation Rules in bulk

POST /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/bulk
Method POST
URL or Endpoint /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/bulk
Headers Authorization, Content-Type
Path Parameters routeAggregationId
Query Parameters Not applicable
Body Parameters name, description, prefix

Path parameters

Parameter
Description
routeAggregationId string
REQUIRED		 Equinix-assigned Fabric Route Aggregations identifier.
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d

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

Sample curl request

Copy 
curl -X POST 'https: //api.equinix.com/fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/bulk'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
  "data": [
    {
      "name": "Private-subnet-filter",
      "description": "string",
      "prefix": "192.168.0.0/24"
    }
  ]
}'

Body parameters

Parameter
Description
prefix string
REQUIRED
 Prefix.
Example: 192.168.0.0/24>
name string
OPTIONAL
 Name.
Example: Private-subnet-aggregation
description string
OPTIONAL
 Description.
Example: test rule

Sample response

Copy 
{
  "pagination": {
    "offset": 0,
    "limit": 32,
    "total": 2,
    "next": null,
    "previous": null
  },
  "data": [
    {
      "href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/65b025ef-022b-4180-85cf-82cfc1ab655b",
      "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE",
      "uuid": "65b025ef-022b-4180-85cf-82cfc1ab655b",
      "name": "Private-subnet-aggregation-2",
      "description": "Test rule",
      "prefix": "192.168.10.0/24",
      "state": "PROVISIONING",
      "change": {
        "href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403/changes/9397f111-19aa-489c-b3c7-349c86818f2d",
        "type": "IPv4_BGP_PREFIX_AGGREGATION_RULE_CREATION",
        "uuid": "9397f111-19aa-489c-b3c7-349c86818f2d"
      },
      "changeLog": {
        "createdBy": "testuser",
        "createdByEmail": "testuser@equinix.com",
        "createdByFullName": "testuser testuser",
        "createdDateTime": "2020-05-21T10:30:00Z"
      }
    },
    {
      "href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/ea48337b-fe04-4164-a3f0-48d81abf575b",
      "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE",
      "uuid": "ea48337b-fe04-4164-a3f0-48d81abf575b",
      "name": "Private-subnet-aggregation-2",
      "description": "Test rule",
      "prefix": "192.168.20.0/24",
      "state": "PROVISIONING",
      "change": {
        "href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403/changes/9397f111-19aa-489c-b3c7-349c86818f2d",
        "type": "IPv4_BGP_PREFIX_AGGREGATION_RULE_CREATION",
        "uuid": "9397f111-19aa-489c-b3c7-349c86818f2d"
      },
      "changeLog": {
        "createdBy": "testuser",
        "createdByEmail": "testuser@equinix.com",
        "createdByFullName": "testuser testuser",
        "createdDateTime": "2020-05-21T10:30:00Z"
      }
    }
  ]
}

Response 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] List of Route Aggregation Rules.
href string
 An absolute URL that returns the specified asset.
Example:https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/65b025ef-022b-4180-85cf-82cfc1ab655b
type string
 Type.
Example: BGP_IPv4_PREFIX_AGGREGATION_RULE
uuid string
 Equinix-assigned asset identifier.
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d
name string
 Route Aggregation Rules name.
Example: My-prefix-aggregation-v4
description string
 Rule description.
Example: Description>
prefix string
 Prefix.
Example: 192.168.10.0/24
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 Rules change.
uuid string
 Uniquely identifies a change.
Example: 04af0d37-9160-43d8-97ef-9da9786996a3
type string
 Type of change.
Example: IPv4_BGP_PREFIX_AGGREGATION_RULE_CREATION
href string
 Route Aggregation Rules Change URI.
Example: https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403/changes/9397f111-19aa-489c-b3c7-349c86818f2d
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 Rule

GET /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/{routeAggregationRuleId}
Method GET
URL or Endpoint /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/{routeAggregationRuleId}
Headers Authorization, Content-Type
Path Parameters routeAggregationId, routeAggregationRuleId
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/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter
Description
routeAggregationId string
REQUIRED		 Equinix-assigned Fabric Route Aggregations identifier.
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d
routeAggregationRuleId string
REQUIRED		 Equinix-assigned Fabric Route Aggregation Rule identifier.
Example: 9890d520-1579-4489-8003-154b34b8f403

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/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403",
  "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE",
  "uuid": "9890d520-1579-4489-8003-154b34b8f403",
  "name": "Private-subnet-aggregation",
  "state": "PROVISIONING",
  "description": "Test rule",
  "change": {
    "href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403/changes/ff9653dc-88c5-47b5-b552-8a08d2f73f7e",
    "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE_CREATION",
    "uuid": "ff9653dc-88c5-47b5-b552-8a08d2f73f7e"
  },
  "prefix": "192.168.0.0/24",
  "changeLog": {
    "createdBy": "testuser",
    "createdByEmail": "testuser@equinix.com",
    "createdByFullName": "testuser testuser",
    "createdDateTime": "2020-05-21T10:30:00Z",
    "updatedBy": "testuser",
    "updatedByEmail": "testuser@equinix.com",
    "updatedByFullName": "testuser testuser",
    "updatedDateTime": "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/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403
type string
 Asset instance type.
Example: BGP_IPv4_PREFIX_AGGREGATION_RULE.
uuid string
 Equinix-assigned asset identifier.
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d
name string
 Route Aggregation Rules name.
Example: My-prefix-aggregation-v4
description string
 Route Aggregation Rules description.
Example: Test aggregation rule
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 Rules change.
uuid string
 Uniquely identifies a change.
Example: 04af0d37-9160-43d8-97ef-9da9786996a3
type string
 Type of change.
Example: BGP_IPv4_PREFIX_RULE_AGGREGATION_CREATION
href string
 Route Aggregation Rules Change URI.
Example: https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403/changes/ff9653dc-88c5-47b5-b552-8a08d2f73f7e
prefix string
 Prefix.
Example: 192.168.0.0/24
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: AverageJoeUp
updatedByFullName string
 First and last name of the asset updater.
Example: Joe Average Up
updatedByEmail string
 Email address of the asset updater.
Example:joe@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

 

Get All Route Aggregation Rules

GET /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules
Method GET
URL or Endpoint /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules
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/routeAggregationRules'
-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": 32,
    "total": 2,
    "next": null,
    "previous": null
  },
  "data": [
    {
      "href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/65b025ef-022b-4180-85cf-82cfc1ab655b",
      "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE",
      "uuid": "65b025ef-022b-4180-85cf-82cfc1ab655b",
      "name": "Private-subnet-aggregation-2",
      "description": "Test rule",
      "prefix": "192.168.10.0/24",
      "state": "PROVISIONED",
      "change": {
        "href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403/changes/9397f111-19aa-489c-b3c7-349c86818f2d",
        "type": "IPv4_BGP_PREFIX_AGGREGATION_RULE_CREATION",
        "uuid": "9397f111-19aa-489c-b3c7-349c86818f2d"
      },
      "changeLog": {
        "createdBy": "testuser",
        "createdByEmail": "testuser@equinix.com",
        "createdByFullName": "testuser testuser",
        "createdDateTime": "2020-05-21T10:30:00Z"
      }
    },
    {
      "href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/ea48337b-fe04-4164-a3f0-48d81abf575b",
      "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE",
      "uuid": "ea48337b-fe04-4164-a3f0-48d81abf575b",
      "name": "Private-subnet-aggregation-2",
      "description": "Test rule",
      "prefix": "192.168.20.0/24",
      "state": "PROVISIONED",
      "change": {
        "href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403/changes/9397f111-19aa-489c-b3c7-349c86818f2d",
        "type": "IPv4_BGP_PREFIX_AGGREGATION_RULE_CREATION",
        "uuid": "9397f111-19aa-489c-b3c7-349c86818f2d"
      },
      "changeLog": {
        "createdBy": "testuser",
        "createdByEmail": "testuser@equinix.com",
        "createdByFullName": "testuser testuser",
        "createdDateTime": "2020-05-21T10:30:00Z"
      }
    }
  ]
}

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] List of Route Aggregation Rules.
href string
 An absolute URL that returns the specified asset.
Example:https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/65b025ef-022b-4180-85cf-82cfc1ab655b
type string
 Type.
Example: BGP_IPv4_PREFIX_AGGREGATION_RULE
uuid string
 Equinix-assigned asset identifier.
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d
name string
 Route Aggregation Rules name.
Example: My-prefix-aggregation-v4
description string
 Rule description.
Example: Description
prefix string
 Prefix.
Example: 192.168.10.0/24
description string
 Additional description.
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 Rules change.
uuid string
 Uniquely identifies a change.
Example: 04af0d37-9160-43d8-97ef-9da9786996a3
type string
 Type of change.
Example: IPv4_BGP_PREFIX_AGGREGATION_RULE_CREATION
href string
 Route Aggregation Rules Change URI.
Example: https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403/changes/9397f111-19aa-489c-b3c7-349c86818f2d
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

 

Update BGP Prefix Route Aggregation Rule

PATCH /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/{routeAggregationRuleId}
Method PATCH
URL or Endpoint /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/{routeAggregationRuleId}
Headers Authorization, Content-Type
Path Parameters routeAggregationId, routeAggregationRuleId
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/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '[
  {
    "op": "replace",
    "path": "/name",
    "value": "test-route-aggregation-name-patch"
  }
]'

Path parameters

Parameter
Description
routeAggregationId string
REQUIRED		 Equinix-assigned Fabric Route Aggregations identifier.
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d
routeAggregationRuleId string
REQUIRED		 Equinix-assigned Fabric Route Aggregation Rule identifier.
Example: 9890d520-1579-4489-8003-154b34b8f403

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


Body parameters

Parameter
Description
op string
REQUIRED
 Update reqest type.
Applicable values:
  • replace
path string
REQUIRED
 Parameter path.
Applicable values:
  • /name
  • /prefix
value string
REQUIRED
 New parameter value.
/name
value string
REQUIRED
 Route Aggregation Rule name.
Example newRuleName
/prefix
value string
REQUIRED
 Route Aggregation Rule prefix.
Example: 192.168.0.0/24


Sample response

Copy 
{
  "href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403",
  "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE",
  "uuid": "9890d520-1579-4489-8003-154b34b8f403",
  "name": "Private-subnet-aggregation-update",
  "description": "Test rule",
  "state": "REPROVISIONING",
  "change": {
    "href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403/changes/a25ca469-721a-4614-89a9-cdef287aa628",
    "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE_UPDATE",
    "uuid": "a25ca469-721a-4614-89a9-cdef287aa628"
  },
  "prefix": "192.168.0.0/24",
  "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"
  }
}

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/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403
type string
 Asset instance type.
Example: BGP_IPv4_PREFIX_AGGREGATION_RULE.
uuid string
 Equinix-assigned asset identifier.
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d
name string
 Route Aggregation Rules name.
Example: My-prefix-aggregation-v4-update
description string
 Route Aggregation Rules description.
Example: Test aggregation rule up
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 Rules change.
uuid string
 Uniquely identifies a change.
Example: 04af0d37-9160-43d8-97ef-9da9786996a3
type string
 Type of change.
Example: BGP_IPv4_PREFIX_RULE_AGGREGATION_UPDATE
href string
 Route Aggregation Rules Change URI.
Example: https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403/changes/ff9653dc-88c5-47b5-b552-8a08d2f73f7e
prefix string
 Prefix.
Example: 192.168.0.0/24
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: AverageJoeUp
updatedByFullName string
 First and last name of the asset updater.
Example: Joe Average Up
updatedByEmail string
 Email address of the asset updater.
Example:joe@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

Replace BGP Prefix Route Aggregation Rule

PUT /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/{routeAggregationRuleId}
Method PUT
URL or Endpoint /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/{routeAggregationRuleId}
Headers Authorization, Content-Type
Path Parameters routeAggregationId, routeAggregationRuleId
Query Parameters Not applicable
Body Parameters name, description, prefix

Sample curl request

Copy 
curl -X PUT 'https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'
-d '{
    "name": "Private-subnet-aggregation-update",
    "description": "Test rule",
    "prefix": "192.168.0.0/24"
}'

Path parameters

Parameter
Description
routeAggregationId string
REQUIRED		 Equinix-assigned Fabric Route Aggregations identifier.
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d
routeAggregationRuleId string
REQUIRED		 Equinix-assigned Fabric Route Aggregation Rule identifier.
Example: 9890d520-1579-4489-8003-154b34b8f403

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


Body parameters

Parameter
Description
prefix string
REQUIRED
 Prefix.
Example: 192.168.0.0/24
name string
OPTIONAL
 Name.
Example: Private-subnet-aggregation
description string
OPTIONAL
 Description.
Example: test rule


Sample response

Copy 
{
  "href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403",
  "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE",
  "uuid": "9890d520-1579-4489-8003-154b34b8f403",
  "name": "Private-subnet-aggregation-update",
  "description": "Test rule",
  "state": "REPROVISIONING",
  "change": {
    "href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403/changes/a25ca469-721a-4614-89a9-cdef287aa628",
    "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE_UPDATE",
    "uuid": "a25ca469-721a-4614-89a9-cdef287aa628"
  },
  "prefix": "192.168.0.0/24",
  "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"
  }
}

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/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403
type string
 Asset instance type.
Example: BGP_IPv4_PREFIX_AGGREGATION_RULE.
uuid string
 Equinix-assigned asset identifier.
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d
name string
 Route Aggregation Rules name.
Example: My-prefix-aggregation-v4-update
description string
 Route Aggregation Rules description.
Example: Test aggregation rule up
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 Rules change.
uuid string
 Uniquely identifies a change.
Example: 04af0d37-9160-43d8-97ef-9da9786996a3
type string
 Type of change.
Example: BGP_IPv4_PREFIX_RULE_AGGREGATION_UPDATE
href string
 Route Aggregation Rules Change URI.
Example: https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403/changes/ff9653dc-88c5-47b5-b552-8a08d2f73f7e
prefix string
 Prefix.
Example: 192.168.0.0/24
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: AverageJoeUp
updatedByFullName string
 First and last name of the asset updater.
Example: Joe Average Up
updatedByEmail string
 Email address of the asset updater.
Example:joe@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

Delete a Route Aggregation Rule

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

Sample curl request

Copy 
curl -X DELETE 'https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'        

Path parameters

Parameter
Description
routeAggregationId string
REQUIRED		 Equinix-assigned Fabric Route Aggregations identifier.
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d
routeAggregationRuleId string
REQUIRED		 Equinix-assigned Fabric Route Aggregation Rule identifier.
Example: 9890d520-1579-4489-8003-154b34b8f403

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/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403",
  "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE",
  "uuid": "9890d520-1579-4489-8003-154b34b8f403",
  "name": "Private-subnet-aggregation",
  "description": "Test rule",
  "state": "DEPROVISIONING",
  "change": {
    "href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403/changes/e8528788-14d3-4a7b-a740-99b702067485",
    "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE_DELETION",
    "uuid": "e8528788-14d3-4a7b-a740-99b702067485"
  },
  "prefix": "192.168.0.0/24",
  "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/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403
type string
 Asset instance type.
Example: BGP_IPv4_PREFIX_AGGREGATION_RULE.
uuid string
 Equinix-assigned asset identifier.
Example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d
name string
 Route Aggregation Rules name.
Example: My-prefix-aggregation-v4-update
description string
 Route Aggregation Rules description.
Example: Test aggregation rule up
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 Rules change.
uuid string
 Uniquely identifies a change.
Example: 04af0d37-9160-43d8-97ef-9da9786996a3
type string
 Type of change.
Example: BGP_IPv4_PREFIX_RULE_AGGREGATION_CREATION
href string
 Route Aggregation Rules Change URI.
Example: https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403/changes/ff9653dc-88c5-47b5-b552-8a08d2f73f7e
prefix string
 Prefix.
Example: 192.168.0.0/24
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: AverageJoeUp
updatedByFullName string
 First and last name of the asset updater.
Example: Joe Average Up
updatedByEmail string
 Email address of the asset updater.
Example:joe@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: AverageJoeUp
deletedByFullName string
 First and last name of the asset remover.
Example: Joe Average Up
deletedByEmail string
 Email address of the asset remover.
Example:joe@average.org
deleteddDateTime 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

Get BGP Prefix Route Aggregation Rule Changes

GET /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/{routeAggregationRuleId}/changes
Method GET
URL or Endpoint /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/{routeAggregationRuleId}/changes
Headers Authorization, Content-Type
Path Parameters routeAggregationId, routeAggregationRuleId
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/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403/changes/ff9653dc-88c5-47b5-b552-8a08d2f73f7e/changes'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter
Description
routeAggregationId string
REQUIRED		 Route Aggregation Id.
Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
routeAggregationRuleId string
REQUIRED		 Route Aggregation Rule Id.
Example: ff9653dc-88c5-47b5-b552-8a08d2f73f7e

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": 3,
    "next": null,
    "previous": null
  },
  "data": [
    {
      "href": "https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403/changes/ff9653dc-88c5-47b5-b552-8a08d2f73f7e",
      "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE_CREATION",
      "uuid": "ff9653dc-88c5-47b5-b552-8a08d2f73f7e",
      "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_RULE",
        "name": "Private-subnet-aggregation",
        "description": "Test rule",
        "prefix": "192.168.0.0/25"
      }
    }
  ]
}

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] List of Route Aggregation Rules.
href string
 An absolute URL that returns the specified asset.
Example:https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/65b025ef-022b-4180-85cf-82cfc1ab655b
type string
 Type.
Example: BGP_IPv4_PREFIX_AGGREGATION_RULE_CREATION
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
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
data object
 Route Aggregation Rule change operation data
name string
 Route Aggregation Rules name.
Example: My-prefix-aggregation-v4
type string
 Type.
Example: BGP_IPv4_PREFIX_AGGREGATION_RULE
prefix string
 Prefix.
Example: 192.168.10.0/24
description string
 Additional description.

Get Specific BGP Prefix Route Aggregation Rule Changes

GET /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/{routeAggregationRuleId}/changes/{changeId}
Method GET
URL or Endpoint /fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/{routeAggregationRuleId}/changes/{changeId}
Headers Authorization, Content-Type
Path Parameters routeAggregationId, routeAggregationRuleId, 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/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403/changes/ff9653dc-88c5-47b5-b552-8a08d2f73f7e'
-H 'content-type: application/json'
-H 'authorization: Bearer qwErtY8zyW1abcdefGHI'

Path parameters

Parameter
Description
routeAggregationId string
REQUIRED		 Route Aggregation Id.
Example: 3a58dd05-f46d-4b1d-a154-2e85c396ea62
routeAggregationRuleId string
REQUIRED		 Route Aggregation Rule Id.
Example: 9890d520-1579-4489-8003-154b34b8f403
changeId string
REQUIRED		 Change Id.
Example: ff9653dc-88c5-47b5-b552-8a08d2f73f7e

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/routeAggregationRules/9890d520-1579-4489-8003-154b34b8f403/changes/ff9653dc-88c5-47b5-b552-8a08d2f73f7e",
  "type": "BGP_IPv4_PREFIX_AGGREGATION_RULE_CREATION",
  "uuid": "ff9653dc-88c5-47b5-b552-8a08d2f73f7e",
  "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_RULE",
    "name": "Private-subnet-aggregation",
    "description": "Test rule",
    "prefix": "192.168.0.0/25"
  }
}

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/routeAggregationRules/65b025ef-022b-4180-85cf-82cfc1ab655b
type string
 Type.
Example: BGP_IPv4_PREFIX_AGGREGATION_RULE_CREATION
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
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
data object
 Route Aggregation Rule change operation data
name string
 Route Aggregation Rules name.
Example: My-prefix-aggregation-v4
type string
 Type.
Example: BGP_IPv4_PREFIX_AGGREGATION_RULE
prefix string
 Prefix.
Example: 192.168.10.0/24
description string
 Additional description.