openapi: 3.0.3 x-eqx-api-linter-skip-rules: [ 3, 24 ] info: title: Equinix Fabric API v4 description: 'Equinix Fabric is an advanced software-defined interconnection solution that enables you to directly, securely and dynamically connect to distributed infrastructure and digital ecosystems on platform Equinix via a single port, Customers can use Fabric to connect to:
1. Cloud Service Providers - Clouds, network and other service providers.
2. Enterprises - Other Equinix customers, vendors and partners.
3. Myself - Another customer instance deployed at Equinix.

Integrations (SDKs, Tools) links:
Fabric Java SDK
Fabric Go SDK
Fabric Python SDK
Equinix Terraform Provider
Fabric Terraform Modules
Equinix Pulumi Provider
' termsOfService: https://www.equinix.com/about/legal/terms contact: name: Equinix API Support url: https://docs.equinix.com/api-support.htm license: name: Equinix Inc url: https://developer.equinix.com/agreement version: "4.21" externalDocs: description: Find more information on Equinix Docs Portal url: https://docs.equinix.com/en-us/apis/fabric servers: - url: https://api.equinix.com description: Equinix Inc security: - BearerAuth: [] tags: - name: Cloud Events description: Cloud Events - name: Cloud Routers description: Cloud Routers - name: Connections description: Connections - name: Metros description: Metros - name: Ports description: Ports - name: Precision Time description: Precision Time Beta - name: Prices description: Prices - name: Route Aggregation Rules description: Route Aggregation Rules - name: Route Aggregations description: Route Aggregations - name: Route Filter Rules description: Route Filter Rules - name: Route Filters description: Route Filters - name: Routing Protocols description: Routing Protocols - name: Service Profiles description: Service Profiles - name: Service Tokens description: Service Tokens - name: Statistics description: Statistics - name: Stream Alert Rules description: Stream Subscriptions - name: Stream Subscriptions description: Stream Subscriptions - name: Streams description: Streams paths: "/fabric/v4/{asset}/{assetId}/cloudevents": get: tags: - Cloud Events summary: Get Cloud Events by Asset Id description: This API provides capability to retrieve cloud events of an asset id operationId: getCloudEventByAssetId parameters: - name: asset in: path description: asset required: true schema: $ref: "#/components/schemas/CloudEventAssetType" - name: assetId in: path description: asset UUID required: true schema: $ref: "#/components/schemas/AssetId" - name: fromDateTime in: query description: Start date and time required: false schema: $ref: "#/components/schemas/StartDateTime" - name: toDateTime in: query description: End date and time required: false schema: $ref: "#/components/schemas/EndDateTime" - name: offset in: query description: offset required: false schema: $ref: "#/components/schemas/Offset" - name: limit in: query description: limit required: false schema: $ref: "#/components/schemas/Limit" responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/GetCloudEventsByAssetResponse" examples: Example: $ref: "#/components/examples/get-cloud-events-by-asset-id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" "/fabric/v4/cloudevents/{cloudEventId}": get: tags: - Cloud Events summary: Get Cloud Event description: This API provides capability to retrieve a cloud event by uuid operationId: getCloudEvent parameters: - name: cloudEventId in: path description: Cloud Event UUID required: true schema: $ref: "#/components/schemas/CloudEventId" responses: "200": description: Cloud Event object content: application/json: schema: $ref: "#/components/schemas/CloudEvent" examples: CloudEventResponseExample: $ref: "#/components/examples/get-cloud-event" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" /fabric/v4/cloudevents/search: post: tags: - Cloud Events summary: Search Cloud Events description: This API provides capability to search cloud events from a filtered query operationId: searchCloudEvents parameters: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/CloudEventSearchRequest" examples: CloudEventSearchRequestExample: $ref: "#/components/examples/search-cloud-events" required: true responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/GetCloudEventsByAssetResponse" examples: Example: $ref: "#/components/examples/get-cloud-events-by-asset-id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" /fabric/v4/connections: post: tags: - Connections summary: Create Connection description: This API provides capability to create user's virtual connection operationId: createConnection parameters: - name: dryRun in: query description: option to verify that API calls will succeed required: false schema: type: boolean default: false requestBody: content: application/json: schema: $ref: "#/components/schemas/ConnectionPostRequest" examples: Colo2Colo-Dot1q2Dot1q: $ref: "#/components/examples/COLO2COLOwithDot1q-Dot1q" Colo2Colo-Dot1q2Dot1q-WithTerms: $ref: "#/components/examples/COLO2COLOwithDot1qAndTerms-Dot1q" Colo2Colo-Dot1q2Dot1q-CRH: $ref: "#/components/examples/COLO2COLOwithDot1q-Dot1q-CRH" Colo2Colo-Dot1q2Qinq: $ref: "#/components/examples/COLO2COLOwithDot1Q-QinQ" Colo2Colo-Qinq2Qinq: $ref: "#/components/examples/COLO2COLOwithQinq-Qinq" Colo2Colo-Qinq2Dot1q: $ref: "#/components/examples/COLO2COLOwithQinq-Dot1q" Colo2Colo-AsResellerForSubCustomer: $ref: "#/components/examples/COLO2COLO-AsReseller" Colo2Colo-Epl: $ref: "#/components/examples/COLO2COLO-EPL" Colo2Colo-Epl-With-Terms: $ref: "#/components/examples/COLO2COLO-EPL-Terms" Colo2Colo-AccessEpl: $ref: "#/components/examples/COLO2COLO-AccessEpl" Colo2Sp-Generic: $ref: "#/components/examples/COLO2SPwithDot1q" Colo2Sp-NetworkEdgeGeneric: $ref: "#/components/examples/COLO2SPwithDot1q" Colo2Sp-Alibaba: $ref: "#/components/examples/COLO2AlibabaSPwithDot1q" Colo2Sp-Aws-Primary: $ref: "#/components/examples/COLO2AWSSPwithDot1q-Primary" Colo2Sp-AzureDot1Q: $ref: "#/components/examples/COLO2AzureSPwithDot1q-Primary" Colo2Sp-AzureQinq: $ref: "#/components/examples/COLO2AzureSPwithQinq-Secondary" Colo2Sp-Google: $ref: "#/components/examples/COLO2GoogleSPwithDot1q" Colo2Sp-Ibm_1.0: $ref: "#/components/examples/COLO2IBM_1" Colo2Sp-Ibm_2.0: $ref: "#/components/examples/COLO2IBM_2" Colo2Sp-Oracle: $ref: "#/components/examples/COLO2OracleSPwithDot1q" Colo2ServiceToken: $ref: "#/components/examples/COLO2ServiceToken" Colo2Network-EVPLAN_VC: $ref: "#/components/examples/COLO2NETWORKwithDot1q" Colo2Network-EVPLAN_VC-With-Terms: $ref: "#/components/examples/COLO2NETWORKwithDot1qAndTerms" Colo2Network-EPLAN_VC: $ref: "#/components/examples/COLO2NETWORKwithEPL" Colo2Network-EPLAN_VC-With-Terms: $ref: "#/components/examples/COLO2NETWORKwithEPLAndTerms" Vd2Network: $ref: "#/components/examples/Vd2NETWORK" Vd2Sp-Aws: $ref: "#/components/examples/Vd2AwsSP" Vd2Sp-Azure: $ref: "#/components/examples/Vd2AzureSP" Vd2Sp-Oracle: $ref: "#/components/examples/Vd2OracleSP" Vd2Sp-IBM_1.0: $ref: "#/components/examples/Vd2Ibm_1" Vd2Sp-IBM_2.0: $ref: "#/components/examples/Vd2Ibm_2" Vd2Sp-Alibaba: $ref: "#/components/examples/Vd2AlibabaSP" Vd2Sp-Google: $ref: "#/components/examples/Vd2GoogleSP" Vd2Sp-Primary: $ref: "#/components/examples/Vd2Sp-Primary" Vd2Sp-Secondary: $ref: "#/components/examples/Vd2Sp-Secondary" Vd2Colo: $ref: "#/components/examples/Vd2Colo" Vd2Colo-vlanTag: $ref: "#/components/examples/Vd2ColoVlanTag" Vd2Colo-vlanCTag: $ref: "#/components/examples/Vd2Colo-VlanCTag" Vd2ColoUntagged: $ref: "#/components/examples/Vd2ColoUntagged" Vd2ServiceToken: $ref: "#/components/examples/Vd2ServiceToken" Fcr2Colo: $ref: "#/components/examples/Fcr2Colo" Fcr2Sp-Google: $ref: "#/components/examples/Fcr2Sp-Google" Fcr2Sp-Azure: $ref: "#/components/examples/Fcr2Sp-Azure" Fcr2Sp-Generic: $ref: "#/components/examples/Fcr2Sp-Generic" Fcr2Sp-Generic-Redundant-Primary: $ref: "#/components/examples/Fcr2Sp-Generic" Fcr2Sp-Generic-Redundant-Secondary: $ref: "#/components/examples/Fcr2Sp-Generic-Redundant-Secondary" Fcr2Sp-Generic-Redundant-Primary-re-add: $ref: "#/components/examples/Fcr2Sp-Generic-Redundant-Primary" Fcr2Sp-Aws: $ref: "#/components/examples/Fcr2Sp-Aws" Fcr2Sp-Oracle: $ref: "#/components/examples/Fcr2Sp-Oracle" Fcr2Vd: $ref: "#/components/examples/Fcr2Vd" Fcr2Vd-Redundant-Secondary: $ref: "#/components/examples/Fcr2Vd-Redundant-Secondary" Fcr2IpWan: $ref: "#/components/examples/Fcr2IpWan" Fcr2Sp-Aws-Marketplace-subscription: $ref: "#/components/examples/Fcr2Sp-Aws-marketplaceSubscription" Fcr2MetalNetwork: $ref: "#/components/examples/Fcr2Metal-Network" Fcr2ServiceToken: $ref: "#/components/examples/Fcr2ServiceToken" AsideServiceToken2ColoWithDot1q: $ref: "#/components/examples/AsideServiceToken2PortWithDot1q" AsideServiceToken2ColoWithQinq: $ref: "#/components/examples/AsideServiceToken2PortWithQinq" AsideServiceToken2PrivateSP-NE: $ref: "#/components/examples/AsideServiceToken2PrivateSP-NE" AsideServiceToken2ZsideServiceToken: $ref: "#/components/examples/AsideServiceToken2ZsideServiceToken" Metal2Sp-Aws: $ref: "#/components/examples/Metal2Sp-Aws" Metal2Sp-Azure: $ref: "#/components/examples/Metal2Sp-Azure" Metal2Sp-GCP: $ref: "#/components/examples/Metal2Sp-GCP" Metal2Sp-Oracle: $ref: "#/components/examples/Metal2Sp-Oracle" Metal2Sp-IBM: $ref: "#/components/examples/Metal2Sp-IBM" Metal2Port-Dot1Q: $ref: "#/components/examples/Metal2Port-Dot1q" Metal2Port-QinQ: $ref: "#/components/examples/Metal2Port-Qinq" Metal2Port-ZsideServiceToken: $ref: "#/components/examples/Metal2ServiceToken" Metal2Sp-Generic: $ref: "#/components/examples/Metal2Sp-Generic" MultiCloudNetwork2Sp-Alibaba: $ref: "#/components/examples/MCNS2Sp-Alibaba" MultiCloudNetwork2Sp-Aws: $ref: "#/components/examples/MCNS2Sp-Aws" MultiCloudNetwork2Sp-GCP: $ref: "#/components/examples/MCNS2Sp-GCP" MultiCloudNetwork2Sp-IBM2: $ref: "#/components/examples/MCNS2Sp-IBM2" MultiCloudNetwork2Sp-Azure: $ref: "#/components/examples/MCNS2Sp-Azure" MultiCloudNetwork2Sp-OCI: $ref: "#/components/examples/MCNS2Sp-OCI" Vd2IASp: $ref: "#/components/examples/Vd2IAProfile-Request" Fcr2Metal-Network: $ref: "#/components/examples/Fcr2Metal-Network" Connection-Colo2Sp-GenericDryRunCreate: $ref: "#/components/examples/CreateConnectionDryRunRequest" required: true responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/Connection" examples: ConnectionDryRun-Colo2AWS: $ref: "#/components/examples/CreateConnectionDryRunResponse-Colo2AWS" ConnectionDryRun-Colo2Azure: $ref: "#/components/examples/CreateConnectionDryRunResponse-Colo2Azure" ConnectionDryRun-Colo2Google: $ref: "#/components/examples/CreateConnectionDryRunResponse-Colo2Google" ConnectionDryRun-Colo2IBM: $ref: "#/components/examples/CreateConnectionDryRunResponse-Colo2IBM" ConnectionDryRun-Colo2Network-EPLAN_VC: $ref: "#/components/examples/CreateConnectionDryRunResponse-Colo2Network-EPLAN_VC" ConnectionDryRun-Colo2Network-EVPLAN_VC: $ref: "#/components/examples/CreateConnectionDryRunResponse-Colo2Network-EVPLAN_VC" ConnectionDryRun-Colo2Sp-Generic: $ref: "#/components/examples/CreateConnectionDryRunResponse-Colo2Sp-Generic" ConnectionDryRun-Fcr2Colo: $ref: "#/components/examples/CreateConnectionDryRunResponse-Fcr2Colo" ConnectionDryRun-Fcr2Ipwan: $ref: "#/components/examples/CreateConnectionDryRunResponse-Fcr2Ipwan" ConnectionDryRun-Fcr2Sp-Generic: $ref: "#/components/examples/CreateConnectionDryRunResponse-Fcr2Sp-Generic" ConnectionDryRun-PortServiceToken2Port: $ref: "#/components/examples/CreateConnectionDryRunResponse-PortServiceToken2Port" "201": description: Accept Connection Request content: application/json: schema: $ref: "#/components/schemas/Connection" examples: Colo2Sp: $ref: "#/components/examples/ConnectionCreateResponse" Colo2Sp-Google: $ref: "#/components/examples/COLO2GoogleSPwithDot1q-Response" Colo2Sp-Alibaba: $ref: "#/components/examples/COLO2AlibabaSP-Response" Colo2Sp-IBM_1.0: $ref: "#/components/examples/COLO2IBM_1" Colo2Sp-IBM_2.0: $ref: "#/components/examples/COLO2IBM_2" Colo2Sp-Oracle: $ref: "#/components/examples/COLO2OracleSP-Response" Vd2Sp: $ref: "#/components/examples/Vd2Sp-Response" Vd2Token: $ref: "#/components/examples/Vd2ServiceToken_Response" Vd2Colo: $ref: "#/components/examples/Vd2Colo-Response" Vd2Colo-tag: $ref: "#/components/examples/Vd2Colo-VlanTagResponse" Vd2ColoUntagged: $ref: "#/components/examples/Vd2ColoUntagged-Response" Fcr2Sp: $ref: "#/components/examples/Fcr2Sp-Response" Fcr2Colo: $ref: "#/components/examples/Fcr2Colo-ResponseExample" Fcr2IpWan: $ref: "#/components/examples/Fcr2IpWan-response" Fcr2Sp-Marketplace-subscription: $ref: "#/components/examples/Fcr2Sp-marketplaceSubscription-Response" ServiceToken2PortResponseDot1Q: $ref: "#/components/examples/AsideServiceToken2PortResponseWithDot1q" ServiceToken2PortResponseQinQ: $ref: "#/components/examples/AsideServiceToken2PortResponseWithQinq" Metal2Sp-Aws: $ref: "#/components/examples/Metal2Sp-Aws-Response" Metal2Sp-Azure: $ref: "#/components/examples/Metal2Sp-Azure-Response" Metal2Sp-GCP: $ref: "#/components/examples/Metal2Sp-GCP-Response" Metal2Sp-Oracle: $ref: "#/components/examples/Metal2Sp-Oracle-Response" Metal2Sp-IBM: $ref: "#/components/examples/Metal2Sp-IBM-Response" Metal2Port-Dot1Q: $ref: "#/components/examples/Metal2Port-Dot1q-Response" Metal2Port-QinQ: $ref: "#/components/examples/Metal2Port-Qinq-Response" Metal2Port-ZsideServiceToken: $ref: "#/components/examples/Metal2ServiceToken-Response" Metal2Sp-Generic: $ref: "#/components/examples/Metal2Sp-Generic-Response" MultiCloudNetwork2Sp-Alibaba: $ref: "#/components/examples/MCNS2Sp-Alibaba-Response" MultiCloudNetwork2Sp-Aws: $ref: "#/components/examples/MCNS2Sp-Aws-Response" MultiCloudNetwork2Sp-GCP: $ref: "#/components/examples/MCNS2Sp-GCP-Response" MultiCloudNetwork2Sp-IBM2: $ref: "#/components/examples/MCNS2Sp-IBM2-Response" MultiCloudNetwork2Sp-Azure: $ref: "#/components/examples/MCNS2Sp-Azure-Response" MultiCloudNetwork2Sp-OCI: $ref: "#/components/examples/MCNS2Sp-OCI-Response" Fcr2Metal-Network: $ref: "#/components/examples/Fcr2Metal-Network" Colo2Network-EVPLAN_VC: $ref: "#/components/examples/COLO2NETWORKwithDot1q-Response" Colo2Network-EVPLAN_VC-WithTerms: $ref: "#/components/examples/COLO2NETWORKwithDot1qAndTerms-Response" Colo2Network-EPLAN_VC: $ref: "#/components/examples/COLO2NETWORKwithEPL-Response" Colo2Network-EPLAN_VC-WithTerms: $ref: "#/components/examples/COLO2NETWORKwithEPLAndTerms-Response" Vd2IASp: $ref: "#/components/examples/Vd2IAProfile-Response" Vd2Network: $ref: "#/components/examples/Vd2NETWORK-Response" Vd2Sp-Aws: $ref: "#/components/examples/Vd2AwsSP-Response" Vd2Sp-Azure: $ref: "#/components/examples/Vd2AzureSP-Response" Vd2Sp-Oracle: $ref: "#/components/examples/Vd2OracleSP-Response" Vd2Sp-IBM_1.0: $ref: "#/components/examples/Vd2Ibm_1" Vd2Sp-IBM_2.0: $ref: "#/components/examples/Vd2Ibm_2" Vd2Sp-Alibaba: $ref: "#/components/examples/Vd2AlibabaSP-Response" Vd2Sp-Google: $ref: "#/components/examples/Vd2GoogleSP-Response" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400" dryRun: $ref: "#/components/examples/400_dry_run" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "405": description: Method not allowed content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/405" "/fabric/v4/connections/{connectionId}": get: tags: - Connections summary: Get Connection by ID description: The API provides capability to get user's virtual connection details (Service Tokens, Access Points, Link Protocols, etc) by it's connection ID (UUID) operationId: getConnectionByUuid parameters: - name: connectionId in: path description: Connection Id required: true schema: $ref: "#/components/schemas/ConnectionId" - name: direction in: query description: Connection Direction required: false schema: $ref: "#/components/schemas/ConnectionDirection" responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/Connection" examples: nonGenericConnectionResponse: $ref: "#/components/examples/NonGenericConnectionResponseExample" genericConnectionResponse: $ref: "#/components/examples/GenericConnectionResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_Invalid_id" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" delete: tags: - Connections summary: Delete by ID description: Delete Connection by ID operationId: deleteConnectionByUuid parameters: - name: connectionId in: path description: Connection UUID required: true schema: $ref: "#/components/schemas/VirtualCircuitId" responses: "200": description: Delete Connection Request content: application/json: schema: $ref: "#/components/schemas/Connection" examples: connectionExample: $ref: "#/components/examples/ConnectionDeletionResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400-delete" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403-delete" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "405": description: Method not allowed content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/405" patch: tags: - Connections summary: Update by ID description: Update Connection by ID operationId: updateConnectionByUuid parameters: - name: connectionId in: path description: Connection Id required: true schema: $ref: "#/components/schemas/ConnectionId" - name: dryRun in: query description: option to verify that API calls will succeed required: false schema: type: boolean default: false requestBody: content: application/json-patch+json: schema: $ref: "#/components/schemas/ConnectionUpdateRequest" examples: ConnectionUpdateNameRequest: $ref: "#/components/examples/ConnectionUpdateNameRequest" ConnectionUpdateBandwidthRequest: $ref: "#/components/examples/ConnectionUpdateBandwidthRequest" ConnectionAddAccessAndSecretKeyAWSRequest: $ref: "#/components/examples/ConnectionAddAccessAndSecretKeyAWSRequest" ConnectionMigrationAsideRequest: $ref: "#/components/examples/ConnectionMigrationAsideRequest" ConnectionUpdateNotificationEmailRequest: $ref: "#/components/examples/ConnectionUpdateNotificationEmailRequest" ConnectionMigrationAsideRequestForVirtualDevice: $ref: "#/components/examples/ConnectionMigrationAsideVirtualDeviceRequest" ConnectionUpdateBandwidthRequestDryRun: $ref: "#/components/examples/ConnectionUpdateBandwidthRequest" required: true responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/Connection" examples: connectionPatchExampleDryRun: $ref: "#/components/examples/ConnectionPatchResponseDryRun" "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/Connection" examples: connectionPatchExample: $ref: "#/components/examples/ConnectionPatchResponse" links: Get Connection Details: operationId: getConnectionByUuid parameters: connectionId: $response.body#/uuid "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400" dryRun: $ref: "#/components/examples/400_dry_run" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "/fabric/v4/connections/{connectionId}/actions": post: tags: - Connections summary: Connection Actions description: This API provides capability to accept/reject user's virtual connection operationId: createConnectionAction parameters: - name: connectionId in: path description: Connection Id required: true schema: $ref: "#/components/schemas/ConnectionId" requestBody: content: application/json: schema: $ref: "#/components/schemas/ConnectionActionRequest" examples: ApproveGenericConnection: $ref: "#/components/examples/Connection_Creation_Acceptance" RejectGenericConnection: $ref: "#/components/examples/Connection_Creation_Rejection" ApproveBandwidthUpdate: $ref: "#/components/examples/Connection_Update_Acceptance" RejectBandwidthUpdate: $ref: "#/components/examples/Connection_Update_Rejection" AcceptDeleteConnection: $ref: "#/components/examples/Connection_Deletion_Acceptance" VcMigrationZSide: $ref: "#/components/examples/Connection_Update_Request_VC_Migration" BGPSync: $ref: "#/components/examples/Connection_Provider_Status_Request" GetProviderBandwidth: $ref: "#/components/examples/Connection_Provider_Bandwidth_Request" AcceptZSide-NetworkEdge: $ref: "#/components/examples/AcceptZSide_NetworkEdge_Request" required: true responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/ConnectionAction" examples: connectionActionExample: $ref: "#/components/examples/ConnectionActionResponse" GetProviderBandwidth: $ref: "#/components/examples/Connection_Provider_Bandwidth_Response" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400" dryRun: $ref: "#/components/examples/400_dry_run" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "/fabric/v4/connections/{connectionId}/advertisedRoutes/search": post: tags: - Cloud Routers summary: Search Advertised Routes description: The API provides capability to get list of user's advertised routes using search criteria, including optional filtering, pagination and sorting operationId: searchConnectionAdvertisedRoutes parameters: - name: connectionId in: path description: Connection Id required: true schema: $ref: "#/components/schemas/ConnectionId" requestBody: content: application/json: schema: $ref: "#/components/schemas/ConnectionRouteSearchRequest" examples: ConnectionRoutesSearchType: $ref: "#/components/examples/ConnectionRoutesSearchByType" ConnectionRoutesSearchByState: $ref: "#/components/examples/ConnectionRoutesSearchByState" ConnectionRoutesSearchByMed: $ref: "#/components/examples/ConnectionRoutesSearchByMed" required: true responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/ConnectionRouteTableEntrySearchResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400" dryRun: $ref: "#/components/examples/400_dry_run" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "/fabric/v4/connections/{connectionId}/receivedRoutes/search": post: tags: - Cloud Routers summary: Search Received Routes description: The API provides capability to get list of received routes using search criteria, including optional filtering, pagination and sorting operationId: searchConnectionReceivedRoutes parameters: - name: connectionId in: path description: Connection Id required: true schema: $ref: "#/components/schemas/ConnectionId" requestBody: content: application/json: schema: $ref: "#/components/schemas/ConnectionRouteSearchRequest" examples: ConnectionRoutesSearchType: $ref: "#/components/examples/ConnectionRoutesSearchByType" ConnectionRoutesSearchByState: $ref: "#/components/examples/ConnectionRoutesSearchByState" ConnectionRoutesSearchByMed: $ref: "#/components/examples/ConnectionRoutesSearchByMed" required: true responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/ConnectionRouteTableEntrySearchResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400" dryRun: $ref: "#/components/examples/400_dry_run" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "/fabric/v4/connections/{connectionId}/routingProtocols": get: tags: - Routing Protocols summary: GetRoutingProtocols description: This API provides capability to get Routing Protocols for connections operationId: getConnectionRoutingProtocols parameters: - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 - name: connectionId in: path description: Connection Id required: true schema: $ref: "#/components/schemas/ConnectionId" responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/GetResponse" examples: getAllRoutingProtocols: $ref: "#/components/examples/RoutingProtocolGetAll" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400" dryRun: $ref: "#/components/examples/400_dry_run" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Connection ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" post: tags: - Routing Protocols summary: Create Protocol description: This API provides capability to create Routing Protocol for connections operationId: createConnectionRoutingProtocol parameters: - name: connectionId in: path description: Connection Id required: true schema: $ref: "#/components/schemas/ConnectionId" requestBody: content: application/json: schema: $ref: "#/components/schemas/RoutingProtocolBase" examples: Fcr2ColoDirectRoutingOnly: $ref: "#/components/examples/Fcr2ColoCreateDirect" Fcr2ColoBGPRoutingOnly: $ref: "#/components/examples/Fcr2ColoCreateBGP" Fcr2GcpDirectRoutingOnly: $ref: "#/components/examples/Fcr2GcpCreateDirect" Fcr2GcpBGPRoutingOnly: $ref: "#/components/examples/Fcr2GcpCreateBGP" required: true responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/RoutingProtocolData" examples: bgpCreateResponse: $ref: "#/components/examples/RoutingProtocolCreateBGPResponse" directCreateResponse: $ref: "#/components/examples/RoutingProtocolCreateDirectResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400" dryRun: $ref: "#/components/examples/400_dry_run" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Connection ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" "/fabric/v4/connections/{connectionId}/routingProtocols/bulk": post: tags: - Routing Protocols summary: Bulk Create Protocol description: This API provides capability to create Routing Protocol for connections operationId: createConnectionRoutingProtocolsInBulk parameters: - name: connectionId in: path description: Connection Id required: true schema: $ref: "#/components/schemas/ConnectionId" requestBody: content: application/json: schema: $ref: "#/components/schemas/ConnectionRoutingProtocolPostRequest" examples: DirectRoutingOnly: $ref: "#/components/examples/CreateRoutingWithDirectOnly" BGPRoutingOnly: $ref: "#/components/examples/CreateRoutingWithBGPOnly" DirectAndBGPRouting: $ref: "#/components/examples/CreateRoutingWithDirectAndBGP" required: true responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/GetResponse" examples: getAllRoutingProtocols: $ref: "#/components/examples/RoutingProtocolGetAll" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_routing_protocol" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Connection ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" "/fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId}": get: tags: - Routing Protocols summary: Get Protocol description: This API provides capability to accept/reject user's virtual connection operationId: getConnectionRoutingProtocolByUuid parameters: - name: routingProtocolId in: path description: Routing Protocol Id required: true schema: $ref: "#/components/schemas/RoutingProtocolId" - name: connectionId in: path description: Connection Id required: true schema: $ref: "#/components/schemas/ConnectionId" responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/RoutingProtocolData" examples: bgpCreateResponse: $ref: "#/components/examples/RoutingProtocolCreateBGPResponse" directCreateResponse: $ref: "#/components/examples/RoutingProtocolCreateDirectResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400" dryRun: $ref: "#/components/examples/400_dry_run" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Connection ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" put: tags: - Routing Protocols summary: Replace Protocol description: This API provides capability to replace complete Routing Protocols on a virtual connection operationId: replaceConnectionRoutingProtocolByUuid parameters: - name: routingProtocolId in: path description: Routing Protocol Id required: true schema: $ref: "#/components/schemas/RoutingProtocolId" - name: connectionId in: path description: Connection Id required: true schema: $ref: "#/components/schemas/ConnectionId" requestBody: content: application/json: schema: $ref: "#/components/schemas/RoutingProtocolBase" examples: DirectRoutingReplaceExample: $ref: "#/components/examples/UpdateRoutingWithDirectOnly" BGPRoutingReplaceExample: $ref: "#/components/examples/UpdateRoutingWithBGPOnly" required: true responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/RoutingProtocolData" examples: bgpReplaceResponse: $ref: "#/components/examples/RoutingProtocolReplaceBGPResponse" directReplaceResponse: $ref: "#/components/examples/RoutingProtocolReplaceDirectResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400" dryRun: $ref: "#/components/examples/400_dry_run" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Connection ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" delete: tags: - Routing Protocols summary: Delete Protocol description: This API provides capability to delete Routing Protocols on virtual connection operationId: deleteConnectionRoutingProtocolByUuid parameters: - name: routingProtocolId in: path description: Routing Protocol Id required: true schema: $ref: "#/components/schemas/RoutingProtocolId" - name: connectionId in: path description: Connection Id required: true schema: $ref: "#/components/schemas/ConnectionId" responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/RoutingProtocolData" examples: directDeleteResponse: $ref: "#/components/examples/RoutingProtocolDeleteDirectResponse" bgpDeleteResponse: $ref: "#/components/examples/RoutingProtocolDeleteBGPResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400" dryRun: $ref: "#/components/examples/400_dry_run" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Connection ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" patch: tags: - Routing Protocols summary: Patch Protocol description: This API provides capability to partially update Routing Protocols on a virtual connection operationId: patchConnectionRoutingProtocolByUuid parameters: - name: routingProtocolId in: path description: Routing Protocol Id required: true schema: $ref: "#/components/schemas/RoutingProtocolId" - name: connectionId in: path description: Connection Id required: true schema: $ref: "#/components/schemas/ConnectionId" requestBody: content: application/json: schema: $ref: "#/components/schemas/ConnectionRoutingProtocolPatchRequest" examples: EnableIPv4PatchExample: $ref: "#/components/examples/PatchRoutingProtocolEnableIPv4" EnableIPv6PatchExample: $ref: "#/components/examples/PatchRoutingProtocolEnableIPv6" DisableIPv4PatchExample: $ref: "#/components/examples/PatchRoutingProtocolDisableIPv4" DisableIPv6PatchExample: $ref: "#/components/examples/PatchRoutingProtocolDisableIPv6" required: true responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/RoutingProtocolData" examples: EnableBGPResponse: $ref: "#/components/examples/RoutingProtocolEnableBGPResponse" DisableBGPResponse: $ref: "#/components/examples/RoutingProtocolDisableBGPResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400" dryRun: $ref: "#/components/examples/400_dry_run" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Connection ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" "/fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId}/actions": get: tags: - Routing Protocols summary: Get BGP Actions description: This API provides capability to get all BGP actions status operationId: getConnectionRoutingProtocolAllBgpActions parameters: - name: routingProtocolId in: path description: Routing Protocol Id required: true schema: $ref: "#/components/schemas/RoutingProtocolId" - name: connectionId in: path description: Connection Id required: true schema: $ref: "#/components/schemas/ConnectionId" - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 responses: "200": description: Fabric BGP Action object content: application/json: schema: $ref: "#/components/schemas/BGPActionsBulkData" examples: BGPActionsAllResponse: $ref: "#/components/examples/BGPActionsBulkDataResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400" dryRun: $ref: "#/components/examples/400_dry_run" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Connection ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" post: tags: - Routing Protocols summary: Clear/Reset BGP description: This API provides capability to clear/reset Routing Protocols BGP session operationId: postConnectionRoutingProtocolBgpActionByUuid parameters: - name: routingProtocolId in: path description: Routing Protocol Id required: true schema: $ref: "#/components/schemas/RoutingProtocolId" - name: connectionId in: path description: Connection Id required: true schema: $ref: "#/components/schemas/ConnectionId" requestBody: content: application/json: schema: $ref: "#/components/schemas/BGPActionRequest" examples: BGPSoftClearInAndOutBoundIPv4: $ref: "#/components/examples/BGPSoftClearInAndOutBoundIPv4" BGPSoftClearInAndOutBoundIPv6: $ref: "#/components/examples/BGPSoftClearInAndOutBoundIPv6" BGPSoftClearInBoundIPv4: $ref: "#/components/examples/BGPSoftClearInBoundIPv4" BGPSoftClearInBoundIPv6: $ref: "#/components/examples/BGPSoftClearInBoundIPv6" BGPHardResetIPv4: $ref: "#/components/examples/BGPHardResetIPv4" BGPHardResetIPv6: $ref: "#/components/examples/BGPHardResetIPv6" required: true responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/BGPActionData" examples: BGPActionHardResetIpV4: $ref: "#/components/examples/BGPHardResetIPv4Response" BGPActionHardResetIpV6: $ref: "#/components/examples/BGPHardResetIPv6Response" BGPActionSoftClearInAndOutIpV4: $ref: "#/components/examples/BGPSoftClearInAndOutBoundIPv4Response" BGPActionSoftClearInAndOutIpV6: $ref: "#/components/examples/BGPSoftClearInAndOutBoundIPv6Response" BGPActionSoftClearInIpV4: $ref: "#/components/examples/BGPSoftClearInBoundIPv4Response" BGPActionSoftClearInIpV6: $ref: "#/components/examples/BGPSoftClearInBoundIPv6Response" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400" dryRun: $ref: "#/components/examples/400_dry_run" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Connection ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" "/fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId}/actions/{actionId}": get: tags: - Routing Protocols summary: Get BGP Action description: This API provides capability to retrieve specific BGP action operationId: getConnectionRoutingProtocolsBgpActionByUuid parameters: - name: connectionId in: path description: Connection Id required: true schema: $ref: "#/components/schemas/ConnectionId" - name: routingProtocolId in: path description: Routing Protocol Id required: true schema: $ref: "#/components/schemas/RoutingProtocolId" - name: actionId in: path description: BGP Action UUID required: true schema: $ref: "#/components/schemas/ActionId" responses: "200": description: Fabric BGP Action object content: application/json: schema: $ref: "#/components/schemas/BGPActionData" examples: BGPActionResponse: $ref: "#/components/examples/BGPActionDataResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_Invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Connection ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" "/fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId}/changes/{changeId}": get: tags: - Routing Protocols summary: Get Change By ID description: This API provides capability to retrieve specific Routing Protocol Change operationId: getConnectionRoutingProtocolsChangeByUuid parameters: - name: connectionId in: path description: Connection Id required: true schema: $ref: "#/components/schemas/ConnectionId" - name: routingProtocolId in: path description: Routing Protocol Id required: true schema: $ref: "#/components/schemas/RoutingProtocolId" - name: changeId in: path description: Routing Protocol Change UUID required: true schema: $ref: "#/components/schemas/ChangeId" responses: "200": description: Fabric Routing Protocol Change object content: application/json: schema: $ref: "#/components/schemas/RoutingProtocolChangeData" examples: RoutingProtocolChangeResponse: $ref: "#/components/examples/RoutingProtocolGetChangeResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_Invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Connection ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" "/fabric/v4/connections/{connectionId}/routingProtocols/{routingProtocolId}/changes": get: tags: - Routing Protocols summary: Get Changes description: This API provides capability to retrieve user's Routing Protocol Changes operationId: getConnectionRoutingProtocolsChanges parameters: - name: connectionId in: path description: Connection Id required: true schema: $ref: "#/components/schemas/ConnectionId" - name: routingProtocolId in: path description: Routing Protocol Id required: true schema: $ref: "#/components/schemas/RoutingProtocolId" - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 responses: "200": description: Fabric Routing Protocol Change object content: application/json: schema: $ref: "#/components/schemas/RoutingProtocolChangeDataResponse" examples: RoutingProtocolChangesResponse: $ref: "#/components/examples/RoutingProtocolGetAllChangesResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_Invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Connection ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" /fabric/v4/connections/search: post: tags: - Connections summary: Search connections description: The API provides capability to get list of user's virtual connections using search criteria, including optional filtering, pagination and sorting operationId: searchConnections parameters: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/SearchRequest" examples: ConnectionSearchDirection: $ref: "#/components/examples/ConnectionSearchDirection" ConnectionSearchIsremote: $ref: "#/components/examples/ConnectionSearchIsremote" ConnectionSearchName: $ref: "#/components/examples/ConnectionSearchName" ConnectionSearchUuid: $ref: "#/components/examples/ConnectionSearchUuid" ConnectionSearchCustorg: $ref: "#/components/examples/ConnectionSearchCustorg" ConnectionSearchAccountname: $ref: "#/components/examples/ConnectionSearchAccountname" ConnectionSearchCloudRouteruuid: $ref: "#/components/examples/ConnectionSearchCloudRouteruuid" ConnectionSearchAsidevlanstagctag: $ref: "#/components/examples/ConnectionSearchAsidevlanstagctag" ConnectionSearchAsidemetrocodemetroname: $ref: "#/components/examples/ConnectionSearchAsidemetrocodemetroname" ConnectionSearchAsideaccesspointname: $ref: "#/components/examples/ConnectionSearchAsideaccesspointname" ConnectionSearchAsideaccesspointuuid: $ref: "#/components/examples/ConnectionSearchAsideaccesspointuuid" ConnectionSearchAsideaccesspointtype: $ref: "#/components/examples/ConnectionSearchAsideaccesspointtype" ConnectionSearchAsidevirtualdevicename: $ref: "#/components/examples/ConnectionSearchAsidevirtualdevicename" ConnectionSearchAsidevirtualdeviceuuid: $ref: "#/components/examples/ConnectionSearchAsidevirtualdeviceuuid" ConnectionSearchAsideservicetokenuuid: $ref: "#/components/examples/ConnectionSearchAsideservicetokenuuid" ConnectionSearchChangestatus: $ref: "#/components/examples/ConnectionSearchChangestatus" ConnectionSearchUpdatedatetime: $ref: "#/components/examples/ConnectionSearchUpdatedatetime" ConnectionSearchEquinixstatus: $ref: "#/components/examples/ConnectionSearchEquinixstatus" ConnectionSearchProviderstatus: $ref: "#/components/examples/ConnectionSearchProviderstatus" ConnectionSearchProjectid: $ref: "#/components/examples/ConnectionSearchProjectidOPtional-CRH" ConnectionSearchRedundancygroup: $ref: "#/components/examples/ConnectionSearchRedundancygroup" ConnectionSearchRedundancypriority: $ref: "#/components/examples/ConnectionSearchRedundancypriority" ConnectionSearchZsidevlanstagctag: $ref: "#/components/examples/ConnectionSearchZsidevlanstagctag" ConnectionSearchZsidemetrocodemetroname: $ref: "#/components/examples/ConnectionSearchZsidemetrocodemetroname" ConnectionSearchZsideaccesspointname: $ref: "#/components/examples/ConnectionSearchZsideaccesspointname" ConnectionSearchZsideaccesspointuuid: $ref: "#/components/examples/ConnectionSearchZsideaccesspointuuid" ConnectionSearchZsideaccesspointtype: $ref: "#/components/examples/ConnectionSearchZsideaccesspointtype" ConnectionSearchZsidevirtualdevicename: $ref: "#/components/examples/ConnectionSearchZsidevirtualdevicename" ConnectionSearchZsidevirtualdeviceuuid: $ref: "#/components/examples/ConnectionSearchZsidevirtualdeviceuuid" ConnectionSearchZsideservicetokenuuid: $ref: "#/components/examples/ConnectionSearchZsideservicetokenuuid" ConnectionSearchZsideprofileuuid: $ref: "#/components/examples/ConnectionSearchZsideprofileuuid" ConnectionSearchANDwithNestedOR-LIKE: $ref: "#/components/examples/ConnectionSearchANDwithNestedOR-LIKE" ConnectionSearchORwithNestedAND: $ref: "#/components/examples/ConnectionSearchORwithNestedAND" ConnectionSearchANDwithNestedIN: $ref: "#/components/examples/ConnectionSearchANDwithNestedIN" ConnectionSearchANDClause: $ref: "#/components/examples/ConnectionSearchANDClause" ConnectionSearchANDwithNestedOR: $ref: "#/components/examples/ConnectionSearchANDwithNestedOR" required: true responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/ConnectionSearchResponse" example: - href: https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62 type: EVPL_VC uuid: 3a58dd05-f46d-4b1d-a154-2e85c396ea62 name: My-Layer2-Connection bandwidth: 1000 direction: OUTGOING isRemote: true redundancy: priority: PRIMARY group: 7cf39156-9dec-40f7-a254-9bb401342e83 aSide: accessPoint: type: COLO uuid: b840a1db-5639-639f-97e0-328a5c00a874 name: exmapple-access-point-name-aside port: href: https://api.equinix.com/fabric/v4/ports/a00cef6f-8e35-4794-9ff9-665e084e4e6d uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d linkProtocol: type: DOT1Q vlanTag: 1001 zSide: accessPoint: type: SP uuid: b840a1db-5639-639f-97e0-328a5c00a875 name: exmapple-access-point-name-zside profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c location: metroCode: MX metroName: Mexico City sellerRegion: us-west-1 routingProtocols: - type: EBGP seqId: 03f7294b-42ce-42b6-9cc8-1e1b46d8183a state: ACTIVE customerAsn: 65500 providerAsn: 65000 bgpAuthKey: testAuthKey ipv4: customerPeerIp: 169.254.255.2/30 providerPeerIp: 169.254.255.1/30 operation: providerStatus: PROVISIONING equinixStatus: PROVISIONED changeLog: createdDateTime: 2020-05-21T10:30:00Z updatedDateTime: 2020-05-21T10:30:00Z project: projectId: 2c10d60e-29c1-4721-ad1a-b531f4e04717 "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400" dryRun: $ref: "#/components/examples/400_dry_run" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" /fabric/v4/prices/search: post: tags: - Prices summary: Get Prices description: Search prices by search criteria operationId: searchPrices parameters: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/FilterBody" examples: virtualConnectionProductEvplVcTypeFromColoToColo: $ref: "#/components/examples/VirtualConnectionProductEvplVcTypeFromColoToColo" virtualConnectionProductEvplVcTypeFromColoToColoByPortUuid: $ref: "#/components/examples/VirtualConnectionProductEvplVcTypeFromColoToColoByPortUuid" virtualConnectionProductEvplVcTypeFromColoToSP: $ref: "#/components/examples/VirtualConnectionProductEvplVcTypeFromColoToSP" virtualConnectionProductFcrVcTypeFromGWToSP: $ref: "#/components/examples/VirtualConnectionProductGwVcTypeFromGWToSP" virtualConnectionProductFcrVcTypeFromGWToColo: $ref: "#/components/examples/VirtualConnectionProductGwVcTypeFromGWToColo" virtualConnectionProductFcrVcTypeFromVDToColo: $ref: "#/components/examples/VirtualConnectionProductGwVcTypeFromVDToColo" virtualConnectionProductEvplVcTypeFromVDToColo: $ref: "#/components/examples/VirtualConnectionProductEvplVcTypeFromVDToColo" virtualConnectionProductVdChainTypeFromVDToChaingroup: $ref: "#/components/examples/VirtualConnectionProductVdChainTypeFromVDToChaingroup" virtualConnectionProductOfflineEvplVcTypeFromColoToSp: $ref: "#/components/examples/VirtualConnectionProductOfflineEvplVcTypeFromColoToSp" virtualConnectionProductOfflineEvpLanVcTypeFromColoToNetwork: $ref: "#/components/examples/VirtualConnectionProductEvpLanVcTypeFromColoToNetwork" cloudRouterProduct: $ref: "#/components/examples/FabricCloudRouterProduct" ipBlockProduct: $ref: "#/components/examples/IpBlockProduct" virtualPortProduct: $ref: "#/components/examples/VirtualPortProduct" precisionTimeProductNtpStandardPackageCode: $ref: "#/components/examples/PrecisionTimeNtpStandardPackage" precisionTimeProductNtpEnterprisePackageCode: $ref: "#/components/examples/PrecisionTimeNtpEnterprisePackage" precisionTimeProductPtpStandardPackageCode: $ref: "#/components/examples/PrecisionTimePtpStandardPackage" precisionTimeProductPtpEnterprisePackageCode: $ref: "#/components/examples/PrecisionTimePtpEnterprisePackage" required: true responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/PriceSearchResponse" examples: virtualConnection: $ref: "#/components/examples/VirtualConnection" ipBlock: $ref: "#/components/examples/IpBlock" cloudRouter: $ref: "#/components/examples/FabricCloudRouter" virtualPort: $ref: "#/components/examples/VirtualPort" precisionTimeService: $ref: "#/components/examples/PrecisionTimeService" "400": description: Bad Request content: application/json: schema: $ref: "#/components/schemas/PriceErrorList" examples: example: $ref: "#/components/examples/400_prices" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/PriceErrorList" examples: example: $ref: "#/components/examples/500_prices" "/fabric/v4/ports/{portId}/stats": get: tags: - Statistics summary: Get Stats by uuid description: This API provides service-level traffic metrics so that you can view access and gather key information required to manage service subscription sizing and capacity. operationId: getPortStatsByPortUuid parameters: - name: portId in: path description: Port UUID required: true schema: $ref: "#/components/schemas/PortUUID" - name: startDateTime in: query description: startDateTime required: true schema: $ref: "#/components/schemas/StartDateTime" example: 2020-11-06T07:00:00Z - name: endDateTime in: query description: endDateTime required: true schema: $ref: "#/components/schemas/EndDateTime" example: 2020-11-10T07:00:00Z responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/Statistics" examples: statsExample: $ref: "#/components/examples/200_port" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" "/fabric/v4/connections/{connectionId}/stats": get: tags: - Statistics summary: Get Stats by uuid description: This API provides service-level metrics so that you can view access and gather key information required to manage service subscription sizing and capacity operationId: getConnectionStatsByPortUuid parameters: - name: connectionId in: path description: Connection UUID required: true schema: $ref: "#/components/schemas/VirtualCircuitId" - name: startDateTime in: query description: startDateTime required: true schema: $ref: "#/components/schemas/StartDateTime" example: 2020-11-06T07:00:00Z - name: endDateTime in: query description: endDateTime required: true schema: $ref: "#/components/schemas/EndDateTime" example: 2020-11-10T07:00:00Z - name: viewPoint in: query description: viewPoint required: true schema: $ref: "#/components/schemas/viewPoint" example: aSide responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/Statistics" examples: statsExample: $ref: "#/components/examples/200_vc" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" /fabric/v4/serviceProfiles: get: tags: - Service Profiles summary: Get all Profiles description: The API request returns all Equinix Fabric Service Profiles in accordance with the view point requested. operationId: getServiceProfiles parameters: - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 - name: viewPoint in: query description: flips view between buyer and seller representation schema: type: string default: aSide enum: - aSide - zSide responses: "200": description: Successful operation content: application/json; charset=UTF-8: schema: $ref: "#/components/schemas/ServiceProfiles" examples: ASideServiceProfile: $ref: "#/components/examples/ServiceProfilesResponse" ZSideServiceProfile: $ref: "#/components/examples/SellerServiceProfilesResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-400" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-403-read" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-500" post: tags: - Service Profiles summary: Create Profile description: Create Service Profile creates Equinix Fabric? Service Profile. operationId: createServiceProfile parameters: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/ServiceProfileRequest" examples: ServiceProfileCreate: $ref: "#/components/examples/ServiceProfileCreate" ServiceProfileCreate-CRH: $ref: "#/components/examples/ServiceProfileCreate-CRH" required: true responses: "201": description: Successful Create operation headers: ETag: $ref: "#/components/headers/ETag" content: application/json; charset=UTF-8: schema: $ref: "#/components/schemas/ServiceProfile" examples: ServiceProfile: $ref: "#/components/examples/ServiceProfileCreateResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-400" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-403-create" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-500" /fabric/v4/serviceProfiles/search: post: tags: - Service Profiles summary: Profile Search description: Search service profiles by search criteria operationId: searchServiceProfiles parameters: - name: viewPoint in: query description: flips view between buyer and seller representation schema: type: string default: aSide enum: - aSide - zSide requestBody: content: application/json: schema: $ref: "#/components/schemas/ServiceProfileSearchRequest" examples: ServiceProfileSearchWithUuid: $ref: "#/components/examples/ServiceProfileSearchWithUuid" ServiceProfileSearchWithName: $ref: "#/components/examples/ServiceProfileSearchWithName" ServiceProfileSearchWithState: $ref: "#/components/examples/ServiceProfileSearchWithState" ServiceProfileSearchWithVisibility: $ref: "#/components/examples/ServiceProfileSearchWithVisibility" ServiceProfileSearchWithProject: $ref: "#/components/examples/ServiceProfileSearchWithProjectId" ServiceProfileSearchWithPort: $ref: "#/components/examples/ServiceProfileSearchWithPort" ServiceProfileSearchWithMultipleFilter: $ref: "#/components/examples/ServiceProfileSearchWithAnd" required: true responses: "200": description: Successful operation content: application/json; charset=UTF-8: schema: $ref: "#/components/schemas/ServiceProfiles" examples: ServiceProfile: $ref: "#/components/examples/ServiceProfilesResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-400-search" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-401" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-500" "/fabric/v4/serviceProfiles/{serviceProfileId}": get: tags: - Service Profiles summary: Get Profile description: Get service profile by UUID. View Point parameter if set to zSide will give seller's view of the profile otherwise buyer's view. operationId: getServiceProfileByUuid parameters: - name: serviceProfileId in: path description: Service Profile UUID required: true schema: $ref: "#/components/schemas/ServiceProfileId" - name: viewPoint in: query description: flips view between buyer and seller representation schema: type: string default: aSide enum: - aSide - zSide responses: "200": description: Successful operation headers: ETag: $ref: "#/components/headers/ETag" content: application/json; charset=UTF-8: schema: $ref: "#/components/schemas/ServiceProfile" examples: ASideServiceProfile: $ref: "#/components/examples/ServiceProfileResponse" ZSideServiceProfile: $ref: "#/components/examples/SellerServiceProfileResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-400" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-403-read" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-500" put: tags: - Service Profiles summary: Replace Profile description: This API request replaces a service profile definition operationId: putServiceProfileByUuid parameters: - name: serviceProfileId in: path description: Service Profile UUID required: true schema: $ref: "#/components/schemas/ServiceProfileId" - name: If-Match in: header description: conditional request required: true schema: type: string requestBody: content: application/json: schema: $ref: "#/components/schemas/ServiceProfileRequest" examples: ServiceProfileUpdate: $ref: "#/components/examples/ServiceProfileUpdate" required: true responses: "202": description: Successful Put operation headers: ETag: $ref: "#/components/headers/ETag" content: application/json; charset=UTF-8: schema: $ref: "#/components/schemas/ServiceProfile" examples: ServiceProfile: $ref: "#/components/examples/ServiceProfilePutResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-400" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-403-update" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-404-get" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-500" delete: tags: - Service Profiles summary: Delete Profile description: delete Service Profile by UUID operationId: deleteServiceProfileByUuid parameters: - name: serviceProfileId in: path description: Service Profile UUID required: true schema: $ref: "#/components/schemas/ServiceProfileId" responses: "200": description: Successful Delete operation headers: ETag: $ref: "#/components/headers/ETag" content: application/json; charset=UTF-8: schema: $ref: "#/components/schemas/ServiceProfile" examples: ServiceProfile: $ref: "#/components/examples/ServiceProfileDeleteResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-400-delete" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-403-delete" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-404-get" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-500" patch: tags: - Service Profiles summary: Update Profile description: Update Service Profile by UUID operationId: updateServiceProfileByUuid parameters: - name: serviceProfileId in: path description: Service Profile UUID required: true schema: $ref: "#/components/schemas/ServiceProfileId" - name: If-Match in: header description: conditional request required: true schema: type: string requestBody: content: application/json-patch+json: schema: $ref: "#/components/schemas/JsonPatch" examples: ServiceProfilePatchRequest: $ref: "#/components/examples/ServiceProfilePatchRequest" required: true responses: "200": description: Successful Patch operation headers: ETag: $ref: "#/components/headers/ETag" content: application/json; charset=UTF-8: schema: $ref: "#/components/schemas/ServiceProfile" examples: ServiceProfile: $ref: "#/components/examples/ServiceProfilePatchResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-400" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-403-update" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-404-get" "412": description: Precondition Failed content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-412" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-500" "/fabric/v4/serviceProfiles/{serviceProfileId}/metros": get: tags: - Service Profiles summary: Get Profile Metros description: Get service profile metros by UUID. operationId: getServiceProfileMetrosByUuid parameters: - name: serviceProfileId in: path description: Service Profile UUID required: true schema: $ref: "#/components/schemas/ServiceProfileId" - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 responses: "200": description: Successful operation content: application/json; charset=UTF-8: schema: $ref: "#/components/schemas/ServiceMetros" examples: ServiceProfileMetros: $ref: "#/components/examples/ServiceProfilesResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-400" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-403-read" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/sp-500" "/fabric/v4/serviceTokens/{serviceTokenId}": get: tags: - Service Tokens summary: Get Token by uuid description: Get Specified Service Tokens uses the uuid of an Equinix Fabric service token to return details about the token's type, state, location, bandwidth, and other key properties. operationId: getServiceTokenByUuid parameters: - name: serviceTokenId in: path description: Service Token UUID required: true schema: $ref: "#/components/schemas/ServiceTokenUUID" responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/ServiceToken" examples: tokenExample: $ref: "#/components/examples/getServiceToken" tokenVDExample: $ref: "#/components/examples/getServiceToken-VD" tokenNetworkExample: $ref: "#/components/examples/getServiceToken-Network" tokenDryRunExample: $ref: "#/components/examples/getServiceToken-DryRun" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_UUID" dryRunExample: $ref: "#/components/examples/400_dry_run" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" delete: tags: - Service Tokens summary: Delete Token by uuid description: Delete Service Tokens removes an Equinix Fabric service token corresponding to the specified uuid which are in INACTIVE state. operationId: deleteServiceTokenByUuid parameters: - name: serviceTokenId in: path description: Service Token UUID required: true schema: $ref: "#/components/schemas/ServiceTokenUUID" responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/ServiceToken" examples: tokenExample: $ref: "#/components/examples/getServiceToken" tokenVDExample: $ref: "#/components/examples/getServiceToken-VD" tokenNetworkExample: $ref: "#/components/examples/getServiceToken-Network" tokenDryRunExample: $ref: "#/components/examples/getServiceToken-DryRun" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_UUID" dryRunExample: $ref: "#/components/examples/400_dry_run" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" patch: tags: - Service Tokens summary: Update Token By ID description: This API provides capability to update user's Service Token operationId: updateServiceTokenByUuid parameters: - name: serviceTokenId in: path description: Service Token UUID required: true schema: $ref: "#/components/schemas/ServiceTokenUUID" - name: dryRun in: query description: option to verify that API calls will succeed required: false schema: type: boolean default: false requestBody: content: application/json-patch+json: schema: $ref: "#/components/schemas/ServiceTokenUpdateRequest" examples: UpdateExpirationDate: $ref: "#/components/examples/UpdateExpirationDate" UpdateTokenName: $ref: "#/components/examples/UpdateTokenName" UpdateTokenDescription: $ref: "#/components/examples/UpdateTokenDescription" UpdateNotificationEmail: $ref: "#/components/examples/UpdateNotificationEmail" UpdateAsideTokenBandwidth: $ref: "#/components/examples/UpdateAsideTokenBandwidth" UpdateZsideTokenBandwidth: $ref: "#/components/examples/UpdateZsideTokenBandwidth" UpdateAsideTokenBandwidthDryRun: $ref: "#/components/examples/UpdateAsideTokenBandwidth" UpdateZsideTokenBandwidthDryRun: $ref: "#/components/examples/UpdateZsideTokenBandwidth" required: true responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/ServiceToken" examples: tokenExample: $ref: "#/components/examples/getServiceToken" tokenVDExample: $ref: "#/components/examples/getServiceToken-VD" tokenNetworkExample: $ref: "#/components/examples/getServiceToken-Network" tokenDryRunExample: $ref: "#/components/examples/getServiceToken-DryRun" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_UUID" dryRunExample: $ref: "#/components/examples/400_dry_run" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" /fabric/v4/serviceTokens: get: tags: - Service Tokens summary: Get All Tokens description: Get All ServiceTokens creates a list of all Equinix Fabric service tokens associated with the subscriber's account. operationId: getServiceTokens parameters: - name: offset in: query description: offset schema: type: number - name: limit in: query description: number of records to fetch schema: type: number responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/ServiceTokens" examples: tokenExample: $ref: "#/components/examples/getServiceTokens" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" post: tags: - Service Tokens summary: Create Service Token description: Create Service Tokens generates Equinix Fabric? service tokens. These tokens authorize users to access protected resources and services. operationId: createServiceToken parameters: - name: dryRun in: query description: option to verify that API calls will succeed required: false schema: type: boolean default: false requestBody: content: application/json: schema: $ref: "#/components/schemas/ServiceToken" examples: AsideTokenWithQnQ: $ref: "#/components/examples/createServiceTokenWithQnQ" AsideTokenWithDot1Q: $ref: "#/components/examples/createServiceTokenWithDot1Q" AsideTokenWithVxlan: $ref: "#/components/examples/createServiceTokenWithVxlan" ZsideTokenWithQnQ: $ref: "#/components/examples/createZsideServiceTokenWithQnQ" ZsideTokenWithDot1Q: $ref: "#/components/examples/createZsideServiceTokenWithDot1Q" ZsideTokenWithVxlan: $ref: "#/components/examples/createZsideServiceTokenWithVxlan" ZsideTokenWithVD: $ref: "#/components/examples/createZsideServiceTokenWithVD" ZsideTokenWithNetwork: $ref: "#/components/examples/createZsideServiceTokenWithNetwork" AsideTokenWithDot1QDryRunCreate: $ref: "#/components/examples/createServiceTokenDryRunRequest" AsideFCRWithZsidePortBasedToken: $ref: "#/components/examples/createZsideServiceTokenWithAsideFCR" required: true responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/ServiceToken" examples: ServiceTokenDryRun: $ref: "#/components/examples/createServiceTokenDryRunResponse" "201": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/ServiceToken" examples: tokenExample: $ref: "#/components/examples/getServiceToken" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400" dryRunExample: $ref: "#/components/examples/400_dry_run" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "/fabric/v4/serviceTokens/{serviceTokenId}/actions": post: tags: - Service Tokens summary: ServiceToken Actions description: This API provides capability to accept/reject user's servicetokens operationId: createServiceTokenAction parameters: - name: serviceTokenId in: path description: Service Token UUID required: true schema: $ref: "#/components/schemas/ServiceTokenUUID" requestBody: content: application/json: schema: $ref: "#/components/schemas/ServiceTokenActionRequest" examples: ResendServiceToken: $ref: "#/components/examples/Resend_Service_Token" required: true responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/ServiceToken" examples: connectionActionExample: $ref: "#/components/examples/postServiceTokenActionResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400" dryRunExample: $ref: "#/components/examples/400_dry_run" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" /fabric/v4/serviceTokens/search: post: tags: - Service Tokens summary: Search servicetokens description: The API provides capability to get list of user's servicetokens using search criteria, including optional filtering, pagination and sorting operationId: searchServiceTokens parameters: - name: offset in: query description: offset schema: type: number - name: limit in: query description: number of records to fetch schema: type: number requestBody: content: application/json: schema: $ref: "#/components/schemas/ServiceTokenSearchRequest" examples: ServiceTokenRequest: $ref: "#/components/examples/postServiceTokenSearchUuid" required: true responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/ServiceTokens" examples: servicetokenSearchExample: $ref: "#/components/examples/getServiceTokens" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400" dryRunExample: $ref: "#/components/examples/400_dry_run" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" /fabric/v4/metros: get: tags: - Metros summary: Get all Metros description: GET All Subscriber Metros with an option query parameter to return all Equinix Fabric metros in which the customer has a presence, as well as latency data for each location. operationId: getMetros parameters: - name: presence in: query description: User On Boarded Metros based on Fabric resource availability required: false schema: $ref: "#/components/schemas/Presence" - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/MetroResponse" examples: metroExample: $ref: "#/components/examples/metro" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/MetroErrorList" examples: example: $ref: "#/components/examples/400_metros" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/MetroErrorList" examples: example: $ref: "#/components/examples/401_metros" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/MetroErrorList" examples: example: $ref: "#/components/examples/500_metros" "/fabric/v4/metros/{metroCode}": get: tags: - Metros summary: Get Metro by Code description: GET Metros retrieves all Equinix Fabric metros, as well as latency data between each metro location. operationId: getMetroByCode parameters: - name: metroCode in: path description: Metro Code required: true schema: $ref: "#/components/schemas/MetroCode" responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/Metro" examples: metroExample: $ref: "#/components/examples/metroByCode" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/MetroErrorList" examples: example: $ref: "#/components/examples/400_metroCode" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/MetroErrorList" examples: example: $ref: "#/components/examples/401_metros" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/MetroErrorList" examples: example: $ref: "#/components/examples/500_metros" /fabric/v4/ports: get: tags: - Ports summary: Get All Ports description: Get All Ports returns details of all assigned and available ports for the specified user credentials. The metro attribute in the response shows the origin of the proposed connection. operationId: getPorts parameters: - name: name in: query description: port name to be provided if specific port(s) to be retrieved schema: type: string responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/AllPortsResponse" examples: portExample: $ref: "#/components/examples/ports" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" post: tags: - Ports summary: Create Port description: Creates Equinix Fabric? Port. operationId: createPort parameters: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/PortRequest" examples: COLOSinglePortNonLag: $ref: "#/components/examples/COLOSinglePortNonLag" COLOSinglePortLag: $ref: "#/components/examples/COLOSinglePortLag" COLOLagPortNewGroup: $ref: "#/components/examples/COLOLagPortNewGroup" COLOAddSecondaryPort: $ref: "#/components/examples/COLOAddSecondaryPort" REMOTESinglePortLag: $ref: "#/components/examples/REMOTESinglePortNewGroupLagRequest" BMMRSinglePortLag: $ref: "#/components/examples/BMMRSinglePortLag" BMMRSinglePortNoLag: $ref: "#/components/examples/BMMRSinglePortNoLag" BMMRAddSecondaryPort: $ref: "#/components/examples/BMMRAddSecondaryPort" BMMRLagPortNewGroup: $ref: "#/components/examples/BMMRLagPortNewGroup" required: true responses: "201": description: Successful operation for COLO Single Port Non Lag content: application/json: schema: $ref: "#/components/schemas/Port" examples: portExample: $ref: "#/components/examples/COLOSinglePortNonLagResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/port-400" "500": description: Internal Server Error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/port-500" /fabric/v4/ports/bulk: post: tags: - Ports summary: Create Port description: Create Port creates Equinix Fabric? Port. Preview operationId: createBulkPort parameters: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/BulkPortRequest" examples: COLOBulkPort: $ref: "#/components/examples/COLOBulkPort" required: true responses: "201": description: Successful operation for COLO Bulk Port content: application/json: schema: $ref: "#/components/schemas/BulkPort" examples: bulkPortExample: $ref: "#/components/examples/COLOBulkPortResponse" "/fabric/v4/ports/{portId}/physicalPorts/bulk": post: tags: - Ports summary: Add to Lag description: Add Physical Ports to Virtual Port. Preview operationId: addToLag parameters: - name: portId in: path description: Port UUID required: true schema: $ref: "#/components/schemas/PortUUID" requestBody: content: application/json: schema: $ref: "#/components/schemas/BulkPhysicalPort" examples: COLOAddToLag: $ref: "#/components/examples/COLOAddToLag" REMOTEAddToLag: $ref: "#/components/examples/REMOTEAddToLag" BMMRAddToLag: $ref: "#/components/examples/BMMRAddToLag" required: true responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/AllPhysicalPortsResponse" examples: COLOAddToLag: $ref: "#/components/examples/COLOAddToLagResponse" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" "/fabric/v4/ports/{portId}": get: tags: - Ports summary: Get Port by uuid description: Get Port By uuid returns details of assigned and available Equinix Fabric port for the specified user credentials. The metro code attribute in the response shows the origin of the proposed connection. operationId: getPortByUuid parameters: - name: portId in: path description: Port UUID required: true schema: $ref: "#/components/schemas/PortUUID" responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/Port" examples: portExample: $ref: "#/components/examples/portByUUID" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" delete: tags: - Ports summary: Delete a single port description: The API provides capability to delete a single port operationId: deletePort parameters: - name: portId in: path description: Port UUID required: true schema: $ref: "#/components/schemas/PortUUID" responses: "202": description: Accepted content: application/json: schema: $ref: "#/components/schemas/Port" examples: portExample: $ref: "#/components/examples/portDelete" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" patch: tags: - Ports summary: Update by UUID description: Update Port by UUID operationId: updatePortByUuid parameters: - name: portId in: path description: Port UUID required: true schema: $ref: "#/components/schemas/PortUUID" requestBody: content: application/json-patch+json: schema: $ref: "#/components/schemas/PortUpdateRequest" examples: PortUpdateNameRequest: $ref: "#/components/examples/PortUpdateNameRequest" required: true responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/AllPortsResponse" examples: portExample: $ref: "#/components/examples/ports" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" "/fabric/v4/ports/{portUuid}/linkProtocols": get: tags: - Ports summary: Get Vlans description: The API provides capability to retrieve Vlans for a Port. operationId: getVlans parameters: - name: portUuid in: path description: Port UUID required: true schema: $ref: "#/components/schemas/PortUUID" responses: "200": description: Get Vlans content: application/json: schema: $ref: "#/components/schemas/LinkProtocolGetResponse" examples: LinkProtocolQ1NQResponse: $ref: "#/components/examples/LinkProtocolGetQinqResponseExample" LinkProtocolDOT1QResponse: $ref: "#/components/examples/LinkProtocolGetDot1qResponseExample" LinkProtocolVlanRangeResponse: $ref: "#/components/examples/LinkProtocolGetVlanRangeResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_invalid_portId" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403-port-access" /fabric/v4/ports/search: post: tags: - Ports summary: Search ports description: The API provides capability to get list of user's virtual ports using search criteria, including optional filtering, pagination and sorting operationId: searchPorts parameters: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/PortV4SearchRequest" examples: PortSearchDirection: $ref: "#/components/examples/PortSearchByProjectId" required: true responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/AllPortsResponse" examples: portExample: $ref: "#/components/examples/ports" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" "/fabric/v4/connections/{connectionId}/routeAggregations": get: tags: - Route Aggregations summary: Get All Aggregations description: This API provides capability to view all Route Aggregations attached to a Connection operationId: getConnectionRouteAggregations parameters: - name: connectionId in: path description: Connection Id required: true schema: $ref: "#/components/schemas/ConnectionId" responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/GetAllConnectionRouteAggregationsResponse" examples: ConnectionRouteAggregationsResponse: $ref: "#/components/examples/ConnectionRouteAggregationsGetAll" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: InvalidInput: $ref: "#/components/examples/400_invalid_input" InvalidId: $ref: "#/components/examples/400_Invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Aggregation ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" "/fabric/v4/connections/{connectionId}/routeAggregations/{routeAggregationId}": get: tags: - Route Aggregations summary: Get Aggregation description: This API provides capability to view a specific Route Aggregation attached to a Connection operationId: getConnectionRouteAggregationByUuid parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: $ref: "#/components/schemas/RouteAggregationId" - name: connectionId in: path description: Connection Id required: true schema: $ref: "#/components/schemas/ConnectionId" responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/ConnectionRouteAggregationData" examples: ConnectionRouteAggregationAttachResponse: $ref: "#/components/examples/AttachConnectionRouteAggregationsResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: InvalidInput: $ref: "#/components/examples/400_invalid_input" InvalidId: $ref: "#/components/examples/400_Invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Aggregation ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" put: tags: - Route Aggregations summary: Attach Aggregation description: This API provides capability to attach a Route Aggregation to a Connection operationId: attachConnectionRouteAggregation parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: $ref: "#/components/schemas/RouteAggregationId" - name: connectionId in: path description: Connection Id required: true schema: $ref: "#/components/schemas/ConnectionId" responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/ConnectionRouteAggregationData" examples: ConnectionRouteAggregationAttachResponse: $ref: "#/components/examples/AttachConnectionRouteAggregationsResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: TransientState: $ref: "#/components/examples/400_transient_state" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Aggregation ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" delete: tags: - Route Aggregations summary: Detach Aggregation description: This API provides capability to detach a Route Aggregation from a Connection operationId: detachConnectionRouteAggregation parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: $ref: "#/components/schemas/RouteAggregationId" - name: connectionId in: path description: Connection Id required: true schema: $ref: "#/components/schemas/ConnectionId" responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/ConnectionRouteAggregationData" examples: ConnectionRouteAggregationDetachResponse: $ref: "#/components/examples/DetachConnectionRouteAggregationResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_transient_state" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Aggregation ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" "/fabric/v4/connections/{connectionId}/routeFilters": get: tags: - Route Filters summary: Get All Route Filters description: This API provides capability to view all Route Filters attached to a Connection operationId: getConnectionRouteFilters parameters: - name: connectionId in: path description: Connection Id required: true schema: $ref: "#/components/schemas/ConnectionId" responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/GetAllConnectionRouteFiltersResponse" examples: ConnectionRouteFiltersResponse: $ref: "#/components/examples/ConnectionRouteFiltersGetAll" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: InvalidInput: $ref: "#/components/examples/400_invalid_input" InvalidId: $ref: "#/components/examples/400_Invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Filter ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" "/fabric/v4/connections/{connectionId}/routeFilters/{routeFilterId}": get: tags: - Route Filters summary: Get Route Filter description: This API provides capability to view a specific Route Filter attached to a Connection operationId: getConnectionRouteFilterByUuid parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: $ref: "#/components/schemas/RouteFilterId" - name: connectionId in: path description: Connection Id required: true schema: $ref: "#/components/schemas/ConnectionId" responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/ConnectionRouteFilterData" examples: ConnectionRouteFilterAttachResponse: $ref: "#/components/examples/AttachConnectionRouteFiltersResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: InvalidInput: $ref: "#/components/examples/400_invalid_input" InvalidId: $ref: "#/components/examples/400_Invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Filter ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" put: tags: - Route Filters summary: Attach Route Filter description: This API provides capability to attach a Route Filter to a Connection operationId: attachConnectionRouteFilter parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: $ref: "#/components/schemas/RouteFilterId" - name: connectionId in: path description: Connection Id required: true schema: $ref: "#/components/schemas/ConnectionId" requestBody: content: application/json: schema: $ref: "#/components/schemas/ConnectionRouteFiltersBase" examples: ConnectionRouteFilterAttachInboundExample: $ref: "#/components/examples/AttachConnectionRouteFilterInbound" ConnectionRouteFilterAttachOutboundExample: $ref: "#/components/examples/AttachConnectionRouteFilterOutbound" required: true responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/ConnectionRouteFilterData" examples: ConnectionRouteFilterAttachResponse: $ref: "#/components/examples/AttachConnectionRouteFiltersResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: InvalidDirection: $ref: "#/components/examples/400_invalid_direction" TransientState: $ref: "#/components/examples/400_transient_state" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Filter ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" delete: tags: - Route Filters summary: Detach Route Filter description: This API provides capability to detach a Route Filter from a Connection operationId: detachConnectionRouteFilter parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: $ref: "#/components/schemas/RouteFilterId" - name: connectionId in: path description: Connection Id required: true schema: $ref: "#/components/schemas/ConnectionId" responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/ConnectionRouteFilterData" examples: ConnectionRouteFilterDetachInboundResponse: $ref: "#/components/examples/DetachConnectionRouteFilterInboundResponse" ConnectionRouteFilterDetachOutboundResponse: $ref: "#/components/examples/DetachConnectionRouteFilterOutboundResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_transient_state" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Filter ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" /fabric/v4/routeFilters: post: tags: - Route Filters summary: Create Route Filters description: This API provides capability to create a Route Filter operationId: createRouteFilter parameters: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/RouteFiltersBase" examples: RouteFilterBgpIpv4Prefix: $ref: "#/components/examples/RouteFilterCreateBgpIpv4Prefix" RouteFilterBgpIpv6Prefix: $ref: "#/components/examples/RouteFilterCreateBgpIpv6Prefix" required: true responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/RouteFiltersData" examples: GetSpecificRouteFilterResponse: $ref: "#/components/examples/RouteFilterCreateBgpIpv4PrefixResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: TransientState: $ref: "#/components/examples/400_transient_state" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Filter ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" "/fabric/v4/routeFilters/{routeFilterId}": get: tags: - Route Filters summary: Get Route Filter By UUID description: This API provides capability to view a Route Filter by UUID operationId: getRouteFilterByUuid parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: $ref: "#/components/schemas/RouteFilterId" responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/RouteFiltersData" examples: GetSpecificRouteFilterResponse: $ref: "#/components/examples/RouteFilterCreateBgpIpv4PrefixResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: InvalidInput: $ref: "#/components/examples/400_invalid_input" InvalidId: $ref: "#/components/examples/400_Invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Filter ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" delete: tags: - Route Filters summary: Delete Route Filter description: This API provides capability to delete a Route Filter operationId: deleteRouteFilterByUuid parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: $ref: "#/components/schemas/RouteFilterId" responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/RouteFiltersData" examples: RouteFilterDeleteBgpIpv4PrefixResponse: $ref: "#/components/examples/RouteFilterDeleteBgpIpv4PrefixResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_attached_connection" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Filter ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" patch: tags: - Route Filters summary: Patch Route Filter description: This API provides capability to partially update a Route Filter operationId: patchRouteFilterByUuid parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: $ref: "#/components/schemas/RouteFilterId" requestBody: content: application/json: schema: $ref: "#/components/schemas/RouteFiltersPatchRequest" examples: RouteFilterNamePatchExample: $ref: "#/components/examples/PatchRouteFilterName" required: true responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/RouteFiltersData" examples: RouteFilterNamePatchResponse: $ref: "#/components/examples/RouteFilterNamePatchResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_invalid_operation" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Filter ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" "/fabric/v4/routeFilters/{routeFilterId}/changes": get: tags: - Route Filters summary: Get All Changes description: This API provides capability to retrieve all of a Route Filter's Changes operationId: getRouteFilterChanges parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: $ref: "#/components/schemas/RouteFilterId" - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 responses: "200": description: Fabric Route Filter Change object content: application/json: schema: $ref: "#/components/schemas/RouteFilterChangeDataResponse" examples: RouteFilterChangesResponse: $ref: "#/components/examples/RouteFilterGetAllChangesResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: InvalidInput: $ref: "#/components/examples/400_invalid_input" InvalidId: $ref: "#/components/examples/400_Invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Filter ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" "/fabric/v4/routeFilters/{routeFilterId}/changes/{changeId}": get: tags: - Route Filters summary: Get Change By ID description: This API provides capability to retrieve a specific Route Filter's Changes operationId: getRouteFilterChangeByUuid parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: $ref: "#/components/schemas/RouteFilterId" - name: changeId in: path description: Routing Protocol Change UUID required: true schema: $ref: "#/components/schemas/ChangeId_1" responses: "200": description: Fabric Route Filter Change object content: application/json: schema: $ref: "#/components/schemas/RouteFilterChangeData" examples: RouteFilterChangeResponse: $ref: "#/components/examples/RouteFilterGetChangeResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: InvalidInput: $ref: "#/components/examples/400_invalid_input" InvalidId: $ref: "#/components/examples/400_Invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Filter ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" "/fabric/v4/routeFilters/{routeFilterId}/connections": get: tags: - Route Filters summary: Get All Connections on Route Filter description: This API provides capability to view all Connections using the Route Filter operationId: getRouteFilterConnections parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: $ref: "#/components/schemas/RouteFilterId" responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/GetRouteFilterGetConnectionsResponse" examples: RouteFilterGetConnectionsResponse: $ref: "#/components/examples/RouteFilterGetConnectionsResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: InvalidInput: $ref: "#/components/examples/400_invalid_input" InvalidId: $ref: "#/components/examples/400_Invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Filter ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" /fabric/v4/routeFilters/search: post: tags: - Route Filters summary: Search Route Filters description: This API provides capability to search Route Filters operationId: searchRouteFilters parameters: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/RouteFiltersSearchBase" examples: searchRouteFiltersRequest: $ref: "#/components/examples/SearchRouteFiltersRequest" required: true responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/RouteFiltersSearchResponse" examples: SearchRouteFiltersResponse: $ref: "#/components/examples/SearchRouteFiltersResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: InvalidInput: $ref: "#/components/examples/400_invalid_input" InvalidId: $ref: "#/components/examples/400_Invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Filter ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" "/fabric/v4/routeFilters/{routeFilterId}/routeFilterRules": get: tags: - Route Filter Rules summary: Get Route Filter Rules description: This API provides capability to get all Route Filters Rules for Fabric operationId: getRouteFilterRules parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: $ref: "#/components/schemas/RouteFilterId" - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/GetRouteFilterRulesResponse" examples: getAllRouteFilterRules: $ref: "#/components/examples/RouteFilterRulesGetAll" "400": description: Resource not found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Filter Rule ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" post: tags: - Route Filter Rules summary: Create Route Filter Rule description: This API provides capability to create a Route Filter Rule operationId: createRouteFilterRule parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: $ref: "#/components/schemas/RouteFilterId" requestBody: content: application/json: schema: $ref: "#/components/schemas/RouteFilterRulesBase" examples: RouteFilterRuleBgpIpv4Prefix: $ref: "#/components/examples/RouteFilterRuleCreateBgpIpv4Prefix" RouteFilterRuleBgpIpv6Prefix: $ref: "#/components/examples/RouteFilterRuleCreateBgpIpv6Prefix" required: true responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/RouteFilterRulesData" examples: GetSpecificRouteFilterRuleIpv4Response: $ref: "#/components/examples/RouteFilterRuleCreateBgpIpv4PrefixResponse" GetSpecificRouteFilterRuleIpv6Response: $ref: "#/components/examples/RouteFilterRuleCreateBgpIpv6PrefixResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: InvalidType: $ref: "#/components/examples/400_bad_request" InvalidId: $ref: "#/components/examples/404_invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Filter Rule ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" "/fabric/v4/routeFilters/{routeFilterId}/routeFilterRules/{routeFilterRuleId}": get: tags: - Route Filter Rules summary: Get Route Filter Rule By UUID description: This API provides capability to view a Route Filter Rule by UUID operationId: getRouteFilterRuleByUuid parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: $ref: "#/components/schemas/RouteFilterId" - name: routeFilterRuleId in: path description: Route Filter Rules Id required: true schema: $ref: "#/components/schemas/RouteFilterRuleId" responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/RouteFilterRulesData" examples: GetSpecificRouteFilterRuleIpv4Response: $ref: "#/components/examples/RouteFilterRuleCreateBgpIpv4PrefixResponse" GetSpecificRouteFilterRuleIpv6Response: $ref: "#/components/examples/RouteFilterRuleCreateBgpIpv6PrefixResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: InvalidType: $ref: "#/components/examples/400_bad_request" InvalidId: $ref: "#/components/examples/404_invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Filter ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" put: tags: - Route Filter Rules summary: Replace Route Filter Rule description: This API provides capability to replace a Route Filter Rule completely operationId: replaceRouteFilterRuleByUuid parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: $ref: "#/components/schemas/RouteFilterId" - name: routeFilterRuleId in: path description: Route Filter Rules Id required: true schema: $ref: "#/components/schemas/RouteFilterRuleId" requestBody: content: application/json: schema: $ref: "#/components/schemas/RouteFilterRulesBase" examples: RouteFilterIpv4ReplaceExample: $ref: "#/components/examples/UpdateRouteFilterRuleIPv4" RouteFilterIpv6ReplaceExample: $ref: "#/components/examples/UpdateRouteFilterRuleIPv6" required: true responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/RouteFilterRulesData" examples: RouteFilterRuleIpv4ReplaceResponse: $ref: "#/components/examples/RouteFilterRuleReplaceIpv4Response" routeFilterRuleIpv6ReplaceResponse: $ref: "#/components/examples/RouteFilterRuleReplaceIpv6Response" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: InvalidType: $ref: "#/components/examples/400_bad_request" InvalidId: $ref: "#/components/examples/404_invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Filter ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" delete: tags: - Route Filter Rules summary: Delete Route Filter Rule description: This API provides capability to delete a Route Filter Rule operationId: deleteRouteFilterRuleByUuid parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: $ref: "#/components/schemas/RouteFilterId" - name: routeFilterRuleId in: path description: Route Filter Rules Id required: true schema: $ref: "#/components/schemas/RouteFilterRuleId" responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/RouteFilterRulesData" examples: RouteFilterDeleteBgpIpv4PrefixResponse: $ref: "#/components/examples/RouteFilterRuleDeleteBgpIpv4PrefixResponse" routeFilterDeleteBgpIpv6PrefixResponse: $ref: "#/components/examples/RouteFilterRuleDeleteBgpIpv6PrefixResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_transient_filter" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Filter ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" patch: tags: - Route Filter Rules summary: Patch Route Filter Rule description: This API provides capability to partially update a Route Filter Rule operationId: patchRouteFilterRuleByUuid parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: $ref: "#/components/schemas/RouteFilterId" - name: routeFilterRuleId in: path description: Route Filter Rules Id required: true schema: $ref: "#/components/schemas/RouteFilterRuleId" requestBody: content: application/json: schema: $ref: "#/components/schemas/RouteFilterRulesPatchRequest" examples: RouteFilterRuleName: $ref: "#/components/examples/PatchRouteFilterRuleName" RouteFilterRulePrefix: $ref: "#/components/examples/PatchRouteFilterRulePrefix" RouteFilterRulePrefixMatch: $ref: "#/components/examples/PatchRouteFilterRulePrefixMatch" required: true responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/RouteFilterRulesData" examples: RouteFilterRuleIpv4ReplaceResponse: $ref: "#/components/examples/RouteFilterRuleReplaceIpv4Response" routeFilterRuleIpv6ReplaceResponse: $ref: "#/components/examples/RouteFilterRuleReplaceIpv6Response" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: InvalidType: $ref: "#/components/examples/400_bad_request" InvalidId: $ref: "#/components/examples/404_invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Filter ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" "/fabric/v4/routeFilters/{routeFilterId}/routeFilterRules/{routeFilterRuleId}/changes": get: tags: - Route Filter Rules summary: Get All Changes description: This API provides capability to retrieve all of a Route Filter Rule's Changes operationId: getRouteFilterRuleChanges parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: $ref: "#/components/schemas/RouteFilterId" - name: routeFilterRuleId in: path description: Route Filter Rules Id required: true schema: $ref: "#/components/schemas/RouteFilterRuleId" - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 responses: "200": description: Fabric Route Filter Rule Change object content: application/json: schema: $ref: "#/components/schemas/RouteFilterRulesChangeDataResponse" examples: RouteFilterRuleChangesResponse: $ref: "#/components/examples/RouteFilterRulesGetAllChangesResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: InvalidInput: $ref: "#/components/examples/400_invalid_input" InvalidId: $ref: "#/components/examples/400_Invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Filter ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" "/fabric/v4/routeFilters/{routeFilterId}/routeFilterRules/{routeFilterRuleId}/changes/{changeId}": get: tags: - Route Filter Rules summary: Get Change By ID description: This API provides capability to retrieve a specific Route Filter Rule's Changes operationId: getRouteFilterRuleChangeByUuid parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: $ref: "#/components/schemas/RouteFilterId" - name: routeFilterRuleId in: path description: Route Filter Rules Id required: true schema: $ref: "#/components/schemas/RouteFilterRuleId" - name: changeId in: path description: Route Filter Rule Change UUID required: true schema: $ref: "#/components/schemas/ChangeId_2" responses: "200": description: Fabric Route Filter Change object content: application/json: schema: $ref: "#/components/schemas/RouteFilterRulesChangeData" examples: RouteFilterChangeResponse: $ref: "#/components/examples/RouteFilterRuleGetChangeResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: InvalidInput: $ref: "#/components/examples/400_invalid_input" InvalidId: $ref: "#/components/examples/400_Invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Filter ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" "/fabric/v4/routeFilters/{routeFilterId}/routeFilterRules/bulk": post: tags: - Route Filter Rules summary: Bulk Create Route Filter Rules description: This API provides capability to create bulk route filter rules operationId: createRouteFilterRulesInBulk parameters: - name: routeFilterId in: path description: Route Filters Id required: true schema: $ref: "#/components/schemas/RouteFilterId" requestBody: content: application/json: schema: $ref: "#/components/schemas/RouteFilterRulesPostRequest" required: true responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/GetRouteFilterRulesResponse" examples: getAllRouteFilterRules: $ref: "#/components/examples/RouteFilterRulesBulkResponse" "400": description: Resource not found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" /fabric/v4/routeAggregations: post: tags: - Route Aggregations summary: Create Aggregations description: This API provides capability to create a Route Aggregation operationId: createRouteAggregation parameters: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/RouteAggregationsBase" examples: RouteAggregationBgpIpv4Prefix: $ref: "#/components/examples/RouteAggregationCreateBgpIpv4Prefix" required: true responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/RouteAggregationsData" examples: GetSpecificRouteAggregationResponse: $ref: "#/components/examples/RouteAggregationCreateBgpIpv4PrefixResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: TransientState: $ref: "#/components/examples/400_transient_state" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Aggregation ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" "/fabric/v4/routeAggregations/{routeAggregationId}": get: tags: - Route Aggregations summary: Get Aggregation description: This API provides capability to view a Route Aggregation by UUID operationId: getRouteAggregationByUuid parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: $ref: "#/components/schemas/RouteAggregationId" responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/RouteAggregationsData" examples: GetSpecificRouteAggregationResponse: $ref: "#/components/examples/RouteAggregationCreateBgpIpv4PrefixResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: InvalidInput: $ref: "#/components/examples/400_invalid_input" InvalidId: $ref: "#/components/examples/400_Invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Aggregation ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" delete: tags: - Route Aggregations summary: Delete Aggregation description: This API provides capability to delete a Route Aggregation operationId: deleteRouteAggregationByUuid parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: $ref: "#/components/schemas/RouteAggregationId" responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/RouteAggregationsData" examples: RouteAggregationDeleteBgpIpv4PrefixResponse: $ref: "#/components/examples/RouteAggregationDeleteBgpIpv4PrefixResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_attached_connection" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Aggregation ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" patch: tags: - Route Aggregations summary: Patch Aggregation description: This API provides capability to partially update a Route Aggregation operationId: patchRouteAggregationByUuid parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: $ref: "#/components/schemas/RouteAggregationId" requestBody: content: application/json: schema: $ref: "#/components/schemas/RouteAggregationsPatchRequest" examples: RouteAggregationNamePatchExample: $ref: "#/components/examples/PatchRouteAggregationName" required: true responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/RouteAggregationsData" examples: RouteAggregationNamePatchResponse: $ref: "#/components/examples/RouteAggregationNamePatchResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_invalid_operation" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Aggregation ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" "/fabric/v4/routeAggregations/{routeAggregationId}/changes": get: tags: - Route Aggregations summary: Get All Changes description: This API provides capability to retrieve all of a Route Aggregation's Changes operationId: getRouteAggregationChanges parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: $ref: "#/components/schemas/RouteAggregationId" - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 responses: "200": description: Fabric Route Aggregation Change object content: application/json: schema: $ref: "#/components/schemas/RouteAggregationChangeDataResponse" examples: RouteAggregationChangesResponse: $ref: "#/components/examples/RouteAggregationGetAllChangesResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: InvalidInput: $ref: "#/components/examples/400_invalid_input" InvalidId: $ref: "#/components/examples/400_Invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Aggregation ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" "/fabric/v4/routeAggregations/{routeAggregationId}/changes/{changeId}": get: tags: - Route Aggregations summary: Get Change By ID description: This API provides capability to retrieve a specific Route Aggregation's Changes operationId: getRouteAggregationChangeByUuid parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: $ref: "#/components/schemas/RouteAggregationId" - name: changeId in: path description: Routing Protocol Change UUID required: true schema: $ref: "#/components/schemas/ChangeId_3" responses: "200": description: Fabric Route Aggregation Change object content: application/json: schema: $ref: "#/components/schemas/RouteAggregationChangeData" examples: RouteAggregationChangeResponse: $ref: "#/components/examples/RouteAggregationGetChangeResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: InvalidInput: $ref: "#/components/examples/400_invalid_input" InvalidId: $ref: "#/components/examples/400_Invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Aggregation ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" "/fabric/v4/routeAggregations/{routeAggregationId}/connections": get: tags: - Route Aggregations summary: Get All Connections on Route Aggregation description: This API provides capability to view all Connections using the Route Aggregation operationId: getRouteAggregationConnections parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: $ref: "#/components/schemas/RouteAggregationId" responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/GetRouteAggregationGetConnectionsResponse" examples: RouteAggregationGetConnectionsResponse: $ref: "#/components/examples/RouteAggregationGetConnectionsResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: InvalidInput: $ref: "#/components/examples/400_invalid_input" InvalidId: $ref: "#/components/examples/400_Invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Aggregation ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" /fabric/v4/routeAggregations/search: post: tags: - Route Aggregations summary: Search Aggregations description: This API provides capability to search Route Aggregations operationId: searchRouteAggregations parameters: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/RouteAggregationsSearchBase" examples: searchRouteAggregationsRequest: $ref: "#/components/examples/SearchRouteAggregationsRequest" required: true responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/RouteAggregationsSearchResponse" examples: SearchRouteAggregationsResponse: $ref: "#/components/examples/SearchRouteAggregationsResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: InvalidInput: $ref: "#/components/examples/400_invalid_input" InvalidId: $ref: "#/components/examples/400_Invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Aggregation ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" "/fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules": get: tags: - Route Aggregation Rules summary: GetRARules description: This API provides capability to get all Route Aggregations Rules for Fabric operationId: getRouteAggregationRules parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: $ref: "#/components/schemas/RouteAggregationId" - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/GetRouteAggregationRulesResponse" examples: getAllRouteAggregationRules: $ref: "#/components/examples/RouteAggregationRulesGetAll" "400": description: Resource not found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Aggregation Rule ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" post: tags: - Route Aggregation Rules summary: Create RARule description: This API provides capability to create a Route Aggregation Rule operationId: createRouteAggregationRule parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: $ref: "#/components/schemas/RouteAggregationId" requestBody: content: application/json: schema: $ref: "#/components/schemas/RouteAggregationRulesBase" examples: RouteAggregationRuleBgpIpv4Prefix: $ref: "#/components/examples/RouteAggregationRuleCreateBgpIpv4Prefix" required: true responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/RouteAggregationRulesData" examples: GetSpecificRouteAggregationRuleIpv4Response: $ref: "#/components/examples/RouteAggregationRuleCreateBgpIpv4PrefixResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: InvalidType: $ref: "#/components/examples/400_bad_request" InvalidId: $ref: "#/components/examples/404_invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Aggregation Rule ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" "/fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/{routeAggregationRuleId}": get: tags: - Route Aggregation Rules summary: GetRARule By UUID description: This API provides capability to view a Route Aggregation Rule by UUID operationId: getRouteAggregationRuleByUuid parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: $ref: "#/components/schemas/RouteAggregationId" - name: routeAggregationRuleId in: path description: Route Aggregation Rules Id required: true schema: $ref: "#/components/schemas/RouteAggregationRuleId" responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/RouteAggregationRulesData" examples: GetSpecificRouteAggregationRuleIpv4Response: $ref: "#/components/examples/RouteAggregationRuleCreateBgpIpv4PrefixResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: InvalidType: $ref: "#/components/examples/400_bad_request" InvalidId: $ref: "#/components/examples/404_invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Aggregation ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" put: tags: - Route Aggregation Rules summary: ReplaceRARule description: This API provides capability to replace a Route Aggregation Rule completely operationId: replaceRouteAggregationRuleByUuid parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: $ref: "#/components/schemas/RouteAggregationId" - name: routeAggregationRuleId in: path description: Route Aggregation Rules Id required: true schema: $ref: "#/components/schemas/RouteAggregationRuleId" requestBody: content: application/json: schema: $ref: "#/components/schemas/RouteAggregationRulesBase" examples: RouteaggregationIpv4ReplaceExample: $ref: "#/components/examples/UpdateRouteAggregationRuleIPv4" required: true responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/RouteAggregationRulesData" examples: RouteAggregationRuleIpv4ReplaceResponse: $ref: "#/components/examples/RouteAggregationRuleReplaceIpv4Response" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: InvalidType: $ref: "#/components/examples/400_bad_request" InvalidId: $ref: "#/components/examples/404_invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Aggregation ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" delete: tags: - Route Aggregation Rules summary: DeleteRARule description: This API provides capability to delete a Route aggregation Rule operationId: deleteRouteAggregationRuleByUuid parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: $ref: "#/components/schemas/RouteAggregationId" - name: routeAggregationRuleId in: path description: Route Aggregation Rules Id required: true schema: $ref: "#/components/schemas/RouteAggregationRuleId" responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/RouteAggregationRulesData" examples: RouteAggregationDeleteBgpIpv4PrefixResponse: $ref: "#/components/examples/RouteAggregationRuleDeleteBgpIpv4PrefixResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_transient_aggregation" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Aggregation ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" patch: tags: - Route Aggregation Rules summary: PatchRARule description: This API provides capability to partially update a Route Aggregation Rule operationId: patchRouteAggregationRuleByUuid parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: $ref: "#/components/schemas/RouteAggregationId" - name: routeAggregationRuleId in: path description: Route Aggregation Rules Id required: true schema: $ref: "#/components/schemas/RouteAggregationRuleId" requestBody: content: application/json: schema: $ref: "#/components/schemas/RouteAggregationRulesPatchRequest" examples: RouteaggregationRuleName: $ref: "#/components/examples/PatchRouteAggregationRuleName" RouteaggregationRulePrefix: $ref: "#/components/examples/PatchRouteAggregationRulePrefix" required: true responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/RouteAggregationRulesData" examples: RouteAggregationRuleIpv4ReplaceResponse: $ref: "#/components/examples/RouteAggregationRuleReplaceIpv4Response" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: InvalidType: $ref: "#/components/examples/400_bad_request" InvalidId: $ref: "#/components/examples/404_invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Aggregation ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" "/fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/{routeAggregationRuleId}/changes": get: tags: - Route Aggregation Rules summary: Get All Changes description: This API provides capability to retrieve all of a Route Aggregation Rule's Changes operationId: getRouteAggregationRuleChanges parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: $ref: "#/components/schemas/RouteAggregationId" - name: routeAggregationRuleId in: path description: Route Aggregation Rules Id required: true schema: $ref: "#/components/schemas/RouteAggregationRuleId" - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 responses: "200": description: Fabric Route Aggregation Rule Change object content: application/json: schema: $ref: "#/components/schemas/RouteAggregationRulesChangeDataResponse" examples: RouteAggregationRuleChangesResponse: $ref: "#/components/examples/RouteAggregationRulesGetAllChangesResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: InvalidInput: $ref: "#/components/examples/400_invalid_input" InvalidId: $ref: "#/components/examples/400_Invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Aggregation ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" "/fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/{routeAggregationRuleId}/changes/{changeId}": get: tags: - Route Aggregation Rules summary: Get Change By ID description: This API provides capability to retrieve a specific Route Aggregation Rule's Changes operationId: getRouteAggregationRuleChangeByUuid parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: $ref: "#/components/schemas/RouteAggregationId" - name: routeAggregationRuleId in: path description: Route Aggregation Rules Id required: true schema: $ref: "#/components/schemas/RouteAggregationRuleId" - name: changeId in: path description: Route Aggregation Rule Change UUID required: true schema: $ref: "#/components/schemas/ChangeId_4" responses: "200": description: Fabric Route Aggregation Change object content: application/json: schema: $ref: "#/components/schemas/RouteAggregationRulesChangeData" examples: RouteAggregationChangeResponse: $ref: "#/components/examples/RouteAggregationRuleGetChangeResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: InvalidInput: $ref: "#/components/examples/400_invalid_input" InvalidId: $ref: "#/components/examples/400_Invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Route Aggregation ID Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" "/fabric/v4/routeAggregations/{routeAggregationId}/routeAggregationRules/bulk": post: tags: - Route Aggregation Rules summary: Bulk RARules description: This API provides capability to create bulk route aggregation rules operationId: createRouteAggregationRulesInBulk parameters: - name: routeAggregationId in: path description: Route Aggregations Id required: true schema: $ref: "#/components/schemas/RouteAggregationId" requestBody: content: application/json: schema: $ref: "#/components/schemas/RouteAggregationRulesPostRequest" required: true responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/GetRouteAggregationRulesResponse" examples: getAllRouteAggregationRules: $ref: "#/components/examples/RouteAggregationRulesBulkResponse" "400": description: Resource not found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_invalid_id" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_internal_error" /fabric/v4/routers: post: tags: - Cloud Routers summary: Create Routers description: This API provides capability to create user's Cloud Routers operationId: createCloudRouter parameters: - name: dryRun in: query description: option to verify that API calls will succeed required: false schema: type: boolean default: false requestBody: content: application/json: schema: $ref: "#/components/schemas/CloudRouterPostRequest" examples: CreateLabPackage: $ref: "#/components/examples/CreateLabPackage" CreateProPackage: $ref: "#/components/examples/CreateStandardPackage" CreateWithMarketplaceSubscription: $ref: "#/components/examples/CreateWithMarketplaceSubscription" required: true responses: "200": description: Fabric Cloud Router object content: application/json: schema: $ref: "#/components/schemas/CloudRouter" examples: cloudRouterResponse: $ref: "#/components/examples/CloudRouterPostResponseExample" cloudRouterResponseForMarketplaceSubscription: $ref: "#/components/examples/CloudRouterPostResponseMarketplaceExample" cloudRouterResponseDryRun: $ref: "#/components/examples/CloudRouterResponseExampleDryRun" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: invalidPackage: $ref: "#/components/examples/400_invalid_package" invalidName: $ref: "#/components/examples/400_invalid_name" invalidAccount: $ref: "#/components/examples/400_invalid_account" maxLabFcrReached: $ref: "#/components/examples/400_max_lab_fcr_demo" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" "/fabric/v4/routers/{routerId}": get: tags: - Cloud Routers summary: Get Routers description: This API provides capability to retrieve user's Cloud Routers operationId: getCloudRouterByUuid parameters: - name: routerId in: path description: Cloud Router UUID required: true schema: $ref: "#/components/schemas/RouterId" responses: "200": description: Fabric Cloud Router object content: application/json: schema: $ref: "#/components/schemas/CloudRouter" examples: cloudRouterResponse: $ref: "#/components/examples/CloudRouterResponseExample" cloudRouterResponseMarketplace: $ref: "#/components/examples/CloudRouterResponseExampleMarketplace" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" delete: tags: - Cloud Routers summary: Delete Routers description: This API provides capability to delete user's Cloud Routers operationId: deleteCloudRouterByUuid parameters: - name: routerId in: path description: Cloud Router UUID required: true schema: $ref: "#/components/schemas/RouterId" responses: "204": description: Deleted Cloud Router Successfully "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_invalid_state" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" patch: tags: - Cloud Routers summary: Update Routers description: This API provides capability to update user's Cloud Routers operationId: updateCloudRouterByUuid parameters: - name: routerId in: path description: Cloud Router UUID required: true schema: $ref: "#/components/schemas/RouterId" requestBody: content: application/json-patch+json: schema: $ref: "#/components/schemas/CloudRouterUpdateRequest" examples: UpdatePackage: $ref: "#/components/examples/UpdatePackage" UpdateName: $ref: "#/components/examples/UpdateName" UpdateNotificationEmail: $ref: "#/components/examples/UpdateNotifications" required: true responses: "200": description: Fabric Cloud Router object content: application/json: schema: $ref: "#/components/schemas/CloudRouter" examples: cloudRouterResponse: $ref: "#/components/examples/CloudRouterPatchResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_invalid_operation" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" "/fabric/v4/routers/{routerId}/actions": get: tags: - Cloud Routers summary: Get Route Table Actions description: This API provides capability to fetch action status operationId: getCloudRouterActions parameters: - name: routerId in: path description: Router UUID required: true schema: $ref: "#/components/schemas/RouterId_1" - name: state in: query description: Action state schema: $ref: "#/components/schemas/ActionState" responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/CloudRouterActionResponse" examples: routerActionExample: $ref: "#/components/examples/CloudRouterActionResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_invalid_operation" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "415": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" post: tags: - Cloud Routers summary: Create Route Table Action description: This API provides capability to refresh route table and bgp session summary information operationId: createCloudRouterAction parameters: - name: routerId in: path description: Router UUID required: true schema: $ref: "#/components/schemas/RouterId_1" requestBody: content: application/json: schema: $ref: "#/components/schemas/CloudRouterActionRequest" examples: RouteEntriesStatusUpdate: $ref: "#/components/examples/RouteEntriesStatusUpdate" ReceivedRouteEntriesStatusUpdate: $ref: "#/components/examples/ReceivedRouteEntriesStatusUpdate" AdvertisedRouteEntriesStatusUpdate: $ref: "#/components/examples/AdvertisedRouteEntriesStatusUpdate" required: true responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/CloudRouterActionResponse" examples: cloudRouterActionExample: $ref: "#/components/examples/CloudRouterActionResponse" receivedRouteEntriesExample: $ref: "#/components/examples/CloudRouterReceivedRoutesActionResponse" advertisedRouteEntriesExample: $ref: "#/components/examples/CloudRouterAdvertisedRoutesActionResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_invalid_operation" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "415": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" "/fabric/v4/routers/{routerId}/actions/search": post: tags: - Cloud Routers summary: Search Route Table Actions description: This API provides capability to refresh route table and bgp session summary information operationId: searchRouterActions parameters: - name: routerId in: path description: Router UUID required: true schema: $ref: "#/components/schemas/RouterId_1" requestBody: content: application/json: schema: $ref: "#/components/schemas/CloudRouterActionsSearchRequest" examples: CloudRouterActionsSearchByType: $ref: "#/components/examples/CloudRouterActionsSearchByType" required: true responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/CloudRouterActionsSearchResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_invalid_sorting" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "415": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" "/fabric/v4/routers/{routerId}/actions/{actionId}": get: tags: - Cloud Routers summary: Get Route Table Action by ID description: This API provides capability to fetch action status operationId: getCloudRouterActionsByUuid parameters: - name: routerId in: path description: Router UUID required: true schema: $ref: "#/components/schemas/RouterId_1" - name: actionId in: path description: Action UUID required: true schema: $ref: "#/components/schemas/ActionId_1" - name: state in: query description: Action state schema: $ref: "#/components/schemas/ActionState" responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/CloudRouterActionResponse" examples: routerActionExample: $ref: "#/components/examples/CloudRouterActionResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_invalid_operation" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "415": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" "/fabric/v4/routers/{routerId}/commands": get: tags: - Cloud Routers summary: Get Commands description: This API provides capability to fetch all commands operationId: getAllCloudRouterCommands parameters: - name: routerId in: path description: Router UUID required: true schema: $ref: "#/components/schemas/RouterId_1" responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/GetAllCloudRouterCommands" examples: getAllCommandsExample: $ref: "#/components/examples/GetAllPingCommandResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_invalid_operation_commands" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403_commands" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_commands" "415": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415_commands" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_commands" post: tags: - Cloud Routers summary: Initiate Command description: This API provides capability to initiate Command operationId: createCloudRouterCommand parameters: - name: routerId in: path description: Router UUID required: true schema: $ref: "#/components/schemas/RouterId_1" requestBody: content: application/json: schema: $ref: "#/components/schemas/CloudRouterCommandPostRequest" examples: InitiatePingCommand: $ref: "#/components/examples/PostRequestPingCommand" required: true responses: "202": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/CloudRouterCommand" examples: initiateCommandsExample: $ref: "#/components/examples/PostResponsePingCommand" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_invalid_operation_commands" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403_commands" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_commands" "415": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415_commands" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_commands" "/fabric/v4/routers/{routerId}/commands/search": post: tags: - Cloud Routers summary: Search Commands description: This API provides capability to search commands operationId: searchCloudRouterCommands parameters: - name: routerId in: path description: Router UUID required: true schema: $ref: "#/components/schemas/RouterId_1" requestBody: content: application/json: schema: $ref: "#/components/schemas/CloudRouterCommandSearchRequest" examples: SearchByState: $ref: "#/components/examples/SearchByStateRequest" required: true responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/CloudRouterCommandSearchResponse" examples: searchCommandsExample: $ref: "#/components/examples/SearchResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_invalid_sorting_commands" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403_commands" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_commands" "415": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415_commands" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_commands" "/fabric/v4/routers/{routerId}/commands/{commandId}": get: tags: - Cloud Routers summary: Get Command description: This API provides capability to fetch command using command Id operationId: getCloudRouterCommand parameters: - name: routerId in: path description: Router UUID required: true schema: $ref: "#/components/schemas/RouterId_1" - name: commandId in: path description: Command UUID required: true schema: $ref: "#/components/schemas/CommandId" responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/CloudRouterCommand" examples: getCommandExample: $ref: "#/components/examples/GetResponsePingCommand" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_invalid_operation_commands" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403_commands" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_commands" "415": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415_commands" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_commands" delete: tags: - Cloud Routers summary: Delete Command description: This API provides capability to delete command based on command Id operationId: deleteCloudRouterCommandByUuid parameters: - name: routerId in: path description: Router UUID required: true schema: $ref: "#/components/schemas/RouterId_1" - name: commandId in: path description: Command UUID required: true schema: $ref: "#/components/schemas/CommandId" responses: "204": description: Deleted command successfully "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_invalid_state_commands" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403_commands" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404_commands" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500_commands" "/fabric/v4/routers/{routerId}/routes/search": post: tags: - Cloud Routers summary: Search Route Table description: The API provides capability to get list of user's Fabric Cloud Router route table entries using search criteria, including optional filtering, pagination and sorting operationId: searchCloudRouterRoutes parameters: - name: routerId in: path description: Router UUID required: true schema: $ref: "#/components/schemas/RouterId_1" requestBody: content: application/json: schema: $ref: "#/components/schemas/RouteTableEntrySearchRequest" examples: SearchFilterByNextHop: $ref: "#/components/examples/SearchFilterByNextHop" SearchFilterByPrefix: $ref: "#/components/examples/SearchFilterByPrefix" SearchFilterByType: $ref: "#/components/examples/SearchFilterByType" SearchFilterByStatus: $ref: "#/components/examples/SearchFilterByStatus" SearchFilterOrAnd: $ref: "#/components/examples/SearchFilterOrAnd" required: true responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/RouteTableEntrySearchResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_invalid_sorting" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "415": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" "/fabric/v4/routers/{routerId}/validate": post: tags: - Routing Protocols summary: Validate Subnet description: This API provides capability to validate all subnets associated with any connection in the given FCR operationId: validateRoutingProtocol parameters: - name: routerId in: path description: Cloud Router UUID required: true schema: $ref: "#/components/schemas/RouterId" requestBody: content: application/json: schema: $ref: "#/components/schemas/ValidateRequest" examples: ValidateDirectIpv4: $ref: "#/components/examples/Request-direct-ipv4" ValidateDirectIpv6: $ref: "#/components/examples/Request-direct-ipv6" required: true responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/ValidateSubnetResponse" examples: ValidateSubnet: $ref: "#/components/examples/Response-200" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: Bad Request: $ref: "#/components/examples/error-400" Subnet Overlapping: $ref: "#/components/examples/error-400-overlappingSubnet" /fabric/v4/routers/search: post: tags: - Cloud Routers summary: Search Routers description: The API provides capability to get list of user's Cloud Routers using search criteria, including optional filtering, pagination and sorting operationId: searchCloudRouters parameters: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/CloudRouterSearchRequest" examples: SearchFilterByStatus: $ref: "#/components/examples/SearchFilterByStatus" SearchFilterByNameAndMetroName: $ref: "#/components/examples/SearchFilterByNameAndMetroName" SearchFilterOrAnd: $ref: "#/components/examples/SearchFilterOrAnd" required: true responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/SearchResponse" examples: Example: $ref: "#/components/examples/search-example" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_invalid_sorting" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" /fabric/v4/routerPackages: get: tags: - Cloud Routers summary: List Packages description: This API provides capability to retrieve user's Cloud Routers Packages operationId: getCloudRouterPackages parameters: - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 responses: "200": description: Fabric Cloud Router Packages content: application/json: schema: $ref: "#/components/schemas/PackageResponse" examples: Example: $ref: "#/components/examples/ListFCRPackagesResponse" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" "/fabric/v4/routerPackages/{routerPackageCode}": get: tags: - Cloud Routers summary: Get Package Details description: This API provides capability to retrieve user's Cloud Routers Package Details operationId: getCloudRouterPackageByCode parameters: - name: routerPackageCode in: path description: Equinix-assigned Cloud Router package identifier required: true schema: $ref: "#/components/schemas/RouterPackageCode" responses: "200": description: Fabric Cloud Router Package details content: application/json: schema: $ref: "#/components/schemas/CloudRouterPackage" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: invalidPackage: $ref: "#/components/examples/400_invalid_package" invalidName: $ref: "#/components/examples/400_invalid_name" invalidAccount: $ref: "#/components/examples/400_invalid_account" maxLabFcrReached: $ref: "#/components/examples/400_max_lab_fcr_demo" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" /fabric/v4/health: get: tags: - Health summary: Get service status description: GET All service health statys with an option query parameter to return all Equinix Fabric customer in which the customer has a presence. operationId: getStatus parameters: [] responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/HealthResponse" examples: metroExample: $ref: "#/components/examples/healthResponse" /fabric/v4/connections/validate: post: tags: - Connections summary: Validate Connection description: This API provides capability to validate by auth key operationId: validateConnections parameters: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/ValidateRequest" examples: Alibaba-ValidateAuthKey: $ref: "#/components/examples/Request_Alibaba" Aws-ValidateAuthKey: $ref: "#/components/examples/Request_AWS" Azure-ValidateAuthKey: $ref: "#/components/examples/Request_Azure" Google-ValidateAuthKey: $ref: "#/components/examples/Request_Google" IBM-1.0-ValidateAuthKey: $ref: "#/components/examples/Request_IBM_1" IBM-2.0-ValidateAuthKey: $ref: "#/components/examples/Request_IBM_2" Oracle-ValidateAuthKey: $ref: "#/components/examples/Request_Oracle" Dot1q-ValidateVlanAvailability: $ref: "#/components/examples/Dot1q_Vlan" Qinq-ValidateVlanAvailability: $ref: "#/components/examples/Qinq_Vlan" required: true responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/ConnectionResponse" examples: Alibaba-ValidateAuthKey: $ref: "#/components/examples/Response-Alibaba" Aws-ValidateAuthKey: $ref: "#/components/examples/Response-Aws" Azure-ValidateAuthKey-no-existing-connections: $ref: "#/components/examples/Response-Azure-no-existing-connections" Azure-ValidateAuthKey-1-existing-Dot1q-connection: $ref: "#/components/examples/Response-Azure-1-existing-Dot1q-connection" Azure-ValidateAuthKey-1-existing-Qinq-connection: $ref: "#/components/examples/Response-Azure-1-existing-Qinq-connection" Azure-ValidateAuthKey-2-existing-Dot1q-connection: $ref: "#/components/examples/Response-Azure-2-existing-Dot1q-connections" Google-ValidateAuthKey: $ref: "#/components/examples/Response-Google" IBM-1.0-ValidateAuthKey: $ref: "#/components/examples/Response-IBM-1" IBM-2.0-ValidateAuthKey: $ref: "#/components/examples/Response-IBM-2" Oracle-ValidateAuthKey: $ref: "#/components/examples/Response-Oracle" Dot1q-ValidateAuthKey: $ref: "#/components/examples/Response-Dot1q-Vlan" Qinq-ValidateAuthKey: $ref: "#/components/examples/Response-Qinq-Vlan" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: Bad Request: $ref: "#/components/examples/error-400" /fabric/v4/networks: post: tags: - Networks summary: Create Network description: This API provides capability to create user's Fabric Network operationId: createNetwork parameters: - name: dryRun in: query description: option to verify that API calls will succeed required: false schema: type: boolean default: false requestBody: content: application/json: schema: $ref: "#/components/schemas/NetworkPostRequest" examples: Create-Global-EVPLAN-Network: $ref: "#/components/examples/Create-Global-EVPLAN-Network" Create-Regional-EVPLAN-Network: $ref: "#/components/examples/Create-Regional-EVPLAN-Network" Create-Local-EVPLAN-Network: $ref: "#/components/examples/Create-Local-EVPLAN-Network" Create-Global-EPLAN-Network: $ref: "#/components/examples/Create-Global-EPLAN-Network" Create-Regional-EPLAN-Network: $ref: "#/components/examples/Create-Regional-EPLAN-Network" Create-Local-EPLAN-Network: $ref: "#/components/examples/Create-Local-EPLAN-Network" Create-Global-EVPTREE-Network: $ref: "#/components/examples/Create-Global-EVPTREE-Network" Create-Regional-EVPTREE-Network: $ref: "#/components/examples/Create-Regional-EVPTREE-Network" Create-Local-EVPTREE-Network: $ref: "#/components/examples/Create-Local-EVPTREE-Network" Create-Global-EPTREE-Network: $ref: "#/components/examples/Create-Global-EPTREE-Network" Create-Regional-EPTREE-Network: $ref: "#/components/examples/Create-Regional-EPTREE-Network" Create-Local-EPTREE-Network: $ref: "#/components/examples/Create-Local-EPTREE-Network" NetworkDryRunCreate: $ref: "#/components/examples/CreateNetworkDryRunResponse" required: true responses: "201": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/Network" examples: EVPLAN-Global-Network: $ref: "#/components/examples/Create-Global-EVPLAN-Network-Response" EVPLAN-Regional-Network: $ref: "#/components/examples/Create-Regional-EVPLAN-Network-Response" EVPLAN-Local-Network: $ref: "#/components/examples/Create-Local-EVPLAN-Network-Response" EPLAN-Global-Network: $ref: "#/components/examples/Create-Global-EPLAN-Network-Response" EPLAN-Regional-Network: $ref: "#/components/examples/Create-Regional-EPLAN-Network-Response" EPLAN-Local-Network: $ref: "#/components/examples/Create-Local-EPLAN-Network-Response" EVPTREE-Global-Network: $ref: "#/components/examples/Create-Global-EVPTREE-Network-Response" EVPTREE-Regional-Network: $ref: "#/components/examples/Create-Regional-EVPTREE-Network-Response" EVPTREE-Local-Network: $ref: "#/components/examples/Create-Local-EVPTREE-Network-Response" EPTREE-Global-Network: $ref: "#/components/examples/Create-Global-EPTREE-Network-Response" EPTREE-Regional-Network: $ref: "#/components/examples/Create-Regional-EPTREE-Network-Response" EPTREE-Local-Network: $ref: "#/components/examples/Create-Local-EPTREE-Network-Response" networkDryRun: $ref: "#/components/examples/CreateNetworkDryRunResponse" "202": description: Fabric Network Access point object content: application/json: schema: $ref: "#/components/schemas/Network" examples: networkResponse: $ref: "#/components/examples/NetworkPostResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" "/fabric/v4/networks/{networkId}": get: tags: - Networks summary: Get Network By ID description: This API provides capability to retrieve user's Fabric Network operationId: getNetworkByUuid parameters: - name: networkId in: path description: Network UUID required: true schema: $ref: "#/components/schemas/NetworkId" responses: "200": description: Fabric Network Access point object content: application/json: schema: $ref: "#/components/schemas/Network" examples: networkResponse: $ref: "#/components/examples/NetworkGetResponseExample" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" delete: tags: - Networks summary: Delete Network By ID description: This API provides capability to delete user's Fabric Network operationId: deleteNetworkByUuid parameters: - name: networkId in: path description: Network UUID required: true schema: $ref: "#/components/schemas/NetworkId" responses: "202": description: Fabric Network Access point object content: application/json: schema: $ref: "#/components/schemas/Network" examples: networkResponse: $ref: "#/components/examples/NetworkDeleteResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_invalid_state" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" patch: tags: - Networks summary: Update Network By ID description: This API provides capability to update user's Fabric Network operationId: updateNetworkByUuid parameters: - name: networkId in: path description: Network UUID required: true schema: $ref: "#/components/schemas/NetworkId" requestBody: content: application/json-patch+json: schema: $ref: "#/components/schemas/NetworkUpdateRequest" examples: UpdateName: $ref: "#/components/examples/UpdateNetworkName" UpdateNotificationEmail: $ref: "#/components/examples/UpdateNetworkNotifications" required: true responses: "200": description: Fabric Network Access point object content: application/json: schema: $ref: "#/components/schemas/Network" examples: networkResponse: $ref: "#/components/examples/NetworkPatchResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_invalid_state" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" /fabric/v4/networks/search: post: tags: - Networks summary: Search Network description: The API provides capability to get list of user's Fabric Network using search criteria, including optional filtering, pagination and sorting operationId: searchNetworks parameters: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/NetworkSearchRequest" examples: SearchFilterByStatus: $ref: "#/components/examples/SearchFilterByStatus" SearchFilterOrAnd: $ref: "#/components/examples/SearchFilterOrAnd" required: true responses: "200": description: Fabric Network Access point object content: application/json: schema: $ref: "#/components/schemas/NetworkSearchResponse" examples: networkResponse: $ref: "#/components/examples/NetworkSearchResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_invalid_sorting" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "/fabric/v4/networks/{networkId}/connections": get: tags: - Networks summary: Get Connections description: The API provides capability to get list of user's Fabric Network connections operationId: getConnectionsByNetworkUuid parameters: - name: networkId in: path description: Network UUID required: true schema: $ref: "#/components/schemas/NetworkId" responses: "200": description: Fabric Network Access point object content: application/json: schema: $ref: "#/components/schemas/NetworkConnections" examples: networkResponse: $ref: "#/components/examples/GetNetworkConnectionExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_invalid_uuid" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "/fabric/v4/networks/{networkId}/changes": get: tags: - Networks summary: Get Network Changes description: The API provides capability to get list of user's Fabric Network changes operationId: getNetworkChanges parameters: - name: networkId in: path description: Network UUID required: true schema: $ref: "#/components/schemas/NetworkId" responses: "200": description: Fabric Network Access point object content: application/json: schema: $ref: "#/components/schemas/NetworkChangeResponse" examples: networkResponse: $ref: "#/components/examples/NetworkChangeResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_invalid_uuid" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "/fabric/v4/networks/{networkId}/changes/{changeId}": get: tags: - Networks summary: Get Change By ID description: This API provides capability to retrieve user's Fabric Network Change operationId: getNetworkChangeByUuid parameters: - name: networkId in: path description: Network UUID required: true schema: $ref: "#/components/schemas/NetworkId" - name: changeId in: path description: Network Change UUID required: true schema: $ref: "#/components/schemas/ChangeId_5" responses: "200": description: Fabric Network Access point object content: application/json: schema: $ref: "#/components/schemas/NetworkChange" examples: networkResponse: $ref: "#/components/examples/NetworkGetChangeResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/400_invalid_uuid" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" /fabric/v4/timeServices: post: tags: - Precision Time summary: Create Time Service description: The API provides capability to create Precision Time service operationId: createTimeServices parameters: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/precisionTimeServiceRequest" examples: ntpStandard: $ref: "#/components/examples/ntpStandardService" ptpStandard: $ref: "#/components/examples/ptpStandardService" ntpEnterprise: $ref: "#/components/examples/ntpEnterpriseService" ptpEnterprise: $ref: "#/components/examples/ptpEnterpriseService" ptpStandardWithAdvancedConfiguration: $ref: "#/components/examples/ptpStandardWithAdvancedConfiguration" ptpEnterpriseWithAdvancedConfiguration: $ref: "#/components/examples/ptpEnterpriseWithAdvancedConfiguration" ntpEnterpriseWithAdvancedConfiguration: $ref: "#/components/examples/ntpEnterpriseWithAdvancedConfiguration" required: true responses: "202": description: Successful Accepted operation content: application/json: schema: $ref: "#/components/schemas/precisionTimeServiceResponse" examples: ntpStandard: $ref: "#/components/examples/ntpStandardCreateResponse" ntpEnterprise: $ref: "#/components/examples/ntpEnterpriseCreateResponse" ptpStandard: $ref: "#/components/examples/ptpStandardCreateResponse" ptpEnterprise: $ref: "#/components/examples/ptpEnterpriseCreateResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: InvalidName: $ref: "#/components/examples/400-Invalid-Name" ValidateName: $ref: "#/components/examples/400-Validate-Name" DuplicateName: $ref: "#/components/examples/400-Duplicate-Name" MandatoryConnectionUuid: $ref: "#/components/examples/400-Mandatory-ConnectionUUid" InvalidConnectionUuidFormat: $ref: "#/components/examples/400-Invalid-ConnectionUuid-Format" InvalidConnectionStatus: $ref: "#/components/examples/400-Invalid-Connection-Status" ValidateConnectionUuid: $ref: "#/components/examples/400-Validate-ConnectionUuid" InvalidConnectionLocation: $ref: "#/components/examples/400-Invalid-Connection-Location" MandatoryPackageType: $ref: "#/components/examples/400-Mandatory-PackageType" InvalidPackageType: $ref: "#/components/examples/400-Invalid-PackageType" InvalidConnectionPackageType: $ref: "#/components/examples/400-Invalid-Connection-PackageType" MandatoryPackage: $ref: "#/components/examples/400-Mandatory-Package" InvalidPackage: $ref: "#/components/examples/400-Invalid-Package" InvalidConnectionPackage: $ref: "#/components/examples/400-Invalid-Connection-Package" MandatoryPrimaryIP: $ref: "#/components/examples/400-Mandatory-PrimaryIP" InvalidPrimaryIPFormat: $ref: "#/components/examples/400-Invalid-PrimaryIP-Format" ValidatePrimaryIP: $ref: "#/components/examples/400-Validate-PrimaryIP" MandatorySecondaryIP: $ref: "#/components/examples/400-Mandatory-SecondaryIP" InvalidSecondaryIPFormat: $ref: "#/components/examples/400-Invalid-SecondaryIP-Format" ValidateSecondaryIP: $ref: "#/components/examples/400-Validate-SecondaryIP" ValidateSameSubnet: $ref: "#/components/examples/400-Validate-SameSubnet" MandatoryNetworkMask: $ref: "#/components/examples/400-Mandatory-NetworkMask" InvalidNetworkMaskFormat: $ref: "#/components/examples/400-Invalid-NetworkMask-Format" ValidateNetworkMask: $ref: "#/components/examples/400-Validate-NetworkMask" InvalidDefaultGatewayFormat: $ref: "#/components/examples/400-Invalid-DefaultGateway-Format" ValidateDefaultGateway: $ref: "#/components/examples/400-Validate-DefaultGateway" InvalidTimeScale: $ref: "#/components/examples/400-Invalid-TimeScale" InvalidDomain: $ref: "#/components/examples/400-Invalid-Domain" InvalidPriority1: $ref: "#/components/examples/400-Invalid-Priority1" InvalidPriority2: $ref: "#/components/examples/400-Invalid-Priority2" InvalidLogAnnounceInterval: $ref: "#/components/examples/400-Invalid-LogAnnounceInterval" ValidateLogAnnounceIntervalRange: $ref: "#/components/examples/400-Validate-LogAnnounceInterval-Range" InvalidLogSyncInterval: $ref: "#/components/examples/400-Invalid-LogSyncInterval" ValidateLogSyncIntervalRange: $ref: "#/components/examples/400-Validate-LogSyncInterval-Range" InvalidLogDelayReqInterval: $ref: "#/components/examples/400-Invalid-LogDelayReqInterval" ValidateLogDelayReqIntervalRange: $ref: "#/components/examples/400-Validate-LogDelayReqInterval-Range" InvalidTransportMode: $ref: "#/components/examples/400-Invalid-TransportMode" InvalidGrantTime: $ref: "#/components/examples/400-Invalid-GrantTime" ValidateGrantTimeRange: $ref: "#/components/examples/400-Validate-GrantTime-Range" InvalidType: $ref: "#/components/examples/400-Invalid-Type" InvalidId: $ref: "#/components/examples/400-Invalid-Id" InvalidPassword: $ref: "#/components/examples/400-Invalid-Password" ValidatePassword: $ref: "#/components/examples/400-Validate-Password" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" "/fabric/v4/timeServices/{serviceId}": get: tags: - Precision Time summary: Get Service By ID. description: The API provides capability to get Precision Time Service details operationId: getTimeServicesById parameters: - name: serviceId in: path description: Service UUID required: true schema: $ref: "#/components/schemas/ServiceId" responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/precisionTimeServiceResponse" examples: ntpStandardOriginPort: $ref: "#/components/examples/ntpStandardResponseASidePort" ntpStandardOriginVirtualDevice: $ref: "#/components/examples/ntpStandardResponseASideVirtualDevice" ntpStandardOriginCloudRouter: $ref: "#/components/examples/ntpStandardResponseASideCloudRouter" ntpEnterpriseOriginPort: $ref: "#/components/examples/ntpEnterpriseWOMD5ResponseASidePort" ntpEnterpriseWithAdvConfigOriginPort: $ref: "#/components/examples/ntpEnterpriseResponseASidePort" ntpEnterpriseWithAdvConfigOriginVirtualDevice: $ref: "#/components/examples/ntpEnterpriseResponseASideVirtualDevice" ntpEnterpriseWithAdvConfigOriginCloudRouter: $ref: "#/components/examples/ntpEnterpriseResponseASideCloudRouter" ptpStandardOriginPort: $ref: "#/components/examples/ptpStandardResponse" ptpEnterpriseOriginPort: $ref: "#/components/examples/ptpEnterpriseResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" put: tags: - Precision Time summary: Configure Service. description: The API provides capability to Configure/Fulfill the Precision Time Service. operationId: fulfillTimeServices parameters: - name: serviceId in: path description: Service UUID required: true schema: $ref: "#/components/schemas/ServiceId" requestBody: content: application/json: schema: $ref: "#/components/schemas/precisionTimeServiceRequest" examples: ntpStandard: $ref: "#/components/examples/configureStandardService" ptpStandard: $ref: "#/components/examples/configureStandardService" ntpEnterpriseWithAdvanceConfiguration: $ref: "#/components/examples/configureNtpEnterpriseAdvancedConfig" ptpEnterpriseWithAdvanceConfiguration: $ref: "#/components/examples/configurePtpWithAdvancedConfig" required: true responses: "202": description: Successful Accepted operation content: application/json: schema: $ref: "#/components/schemas/precisionTimeServiceResponse" examples: ntpStandard: $ref: "#/components/examples/ntpStandardConfigureResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: InvalidName: $ref: "#/components/examples/400-Invalid-Name" ValidateName: $ref: "#/components/examples/400-Validate-Name" DuplicateName: $ref: "#/components/examples/400-Duplicate-Name" MandatoryConnectionUuid: $ref: "#/components/examples/400-Mandatory-ConnectionUUid" InvalidConnectionUuidFormat: $ref: "#/components/examples/400-Invalid-ConnectionUuid-Format" InvalidConnectionStatus: $ref: "#/components/examples/400-Invalid-Connection-Status" ValidateConnectionUuid: $ref: "#/components/examples/400-Validate-ConnectionUuid" InvalidConnectionLocation: $ref: "#/components/examples/400-Invalid-Connection-Location" MandatoryPackageType: $ref: "#/components/examples/400-Mandatory-PackageType" InvalidPackageType: $ref: "#/components/examples/400-Invalid-PackageType" InvalidConnectionPackageType: $ref: "#/components/examples/400-Invalid-Connection-PackageType" MandatoryPackage: $ref: "#/components/examples/400-Mandatory-Package" InvalidPackage: $ref: "#/components/examples/400-Invalid-Package" InvalidConnectionPackage: $ref: "#/components/examples/400-Invalid-Connection-Package" MandatoryPrimaryIP: $ref: "#/components/examples/400-Mandatory-PrimaryIP" InvalidPrimaryIPFormat: $ref: "#/components/examples/400-Invalid-PrimaryIP-Format" ValidatePrimaryIP: $ref: "#/components/examples/400-Validate-PrimaryIP" MandatorySecondaryIP: $ref: "#/components/examples/400-Mandatory-SecondaryIP" InvalidSecondaryIPFormat: $ref: "#/components/examples/400-Invalid-SecondaryIP-Format" ValidateSecondaryIP: $ref: "#/components/examples/400-Validate-SecondaryIP" ValidateSameSubnet: $ref: "#/components/examples/400-Validate-SameSubnet" MandatoryNetworkMask: $ref: "#/components/examples/400-Mandatory-NetworkMask" InvalidNetworkMaskFormat: $ref: "#/components/examples/400-Invalid-NetworkMask-Format" ValidateNetworkMask: $ref: "#/components/examples/400-Validate-NetworkMask" InvalidDefaultGatewayFormat: $ref: "#/components/examples/400-Invalid-DefaultGateway-Format" ValidateDefaultGateway: $ref: "#/components/examples/400-Validate-DefaultGateway" InvalidTimeScale: $ref: "#/components/examples/400-Invalid-TimeScale" InvalidDomain: $ref: "#/components/examples/400-Invalid-Domain" InvalidPriority1: $ref: "#/components/examples/400-Invalid-Priority1" InvalidPriority2: $ref: "#/components/examples/400-Invalid-Priority2" InvalidLogAnnounceInterval: $ref: "#/components/examples/400-Invalid-LogAnnounceInterval" ValidateLogAnnounceIntervalRange: $ref: "#/components/examples/400-Validate-LogAnnounceInterval-Range" InvalidLogSyncInterval: $ref: "#/components/examples/400-Invalid-LogSyncInterval" ValidateLogSyncIntervalRange: $ref: "#/components/examples/400-Validate-LogSyncInterval-Range" InvalidLogDelayReqInterval: $ref: "#/components/examples/400-Invalid-LogDelayReqInterval" ValidateLogDelayReqIntervalRange: $ref: "#/components/examples/400-Validate-LogDelayReqInterval-Range" InvalidTransportMode: $ref: "#/components/examples/400-Invalid-TransportMode" InvalidGrantTime: $ref: "#/components/examples/400-Invalid-GrantTime" ValidateGrantTimeRange: $ref: "#/components/examples/400-Validate-GrantTime-Range" InvalidType: $ref: "#/components/examples/400-Invalid-Type" InvalidId: $ref: "#/components/examples/400-Invalid-Id" InvalidPassword: $ref: "#/components/examples/400-Invalid-Password" ValidatePassword: $ref: "#/components/examples/400-Validate-Password" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" delete: tags: - Precision Time summary: Delete by ID. description: The API provides capability to delete Precision Time Service by service id. operationId: deleteTimeServiceById parameters: - name: serviceId in: path description: Service UUID required: true schema: $ref: "#/components/schemas/ServiceId" responses: "202": description: Successful Delete content: application/json: schema: $ref: "#/components/schemas/precisionTimeServiceResponse" examples: ntpStandard: $ref: "#/components/examples/ntpStandardDeletingResponse" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" patch: tags: - Precision Time summary: Update By ID. description: The API provides capability to update Precision Time Service by service id. operationId: updateTimeServicesById parameters: - name: serviceId in: path description: Service UUID required: true schema: $ref: "#/components/schemas/ServiceId" requestBody: content: application/json-patch+json: schema: maxItems: 1 minItems: 1 type: array items: $ref: "#/components/schemas/precisionTimeChangeOperation" examples: updateName: $ref: "#/components/examples/updateName" updatePackageCode: $ref: "#/components/examples/updatePackageCode" updateNetworkInformation: $ref: "#/components/examples/updateNetworkInformation" updatePtpAdvancedConfiguration: $ref: "#/components/examples/updatePtpAdvancedConfiguration" updateNtpAdvancedConfiguration: $ref: "#/components/examples/updateNtpAdvancedConfiguration" required: true responses: "202": description: Successful Accepted operation content: application/json: schema: $ref: "#/components/schemas/precisionTimeServiceResponse" examples: ntpStandard: $ref: "#/components/examples/ntpStandardReprovisionResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: InvalidName: $ref: "#/components/examples/400-Invalid-Name" ValidateName: $ref: "#/components/examples/400-Validate-Name" DuplicateName: $ref: "#/components/examples/400-Duplicate-Name" MandatoryConnectionUuid: $ref: "#/components/examples/400-Mandatory-ConnectionUUid" InvalidConnectionUuidFormat: $ref: "#/components/examples/400-Invalid-ConnectionUuid-Format" InvalidConnectionStatus: $ref: "#/components/examples/400-Invalid-Connection-Status" ValidateConnectionUuid: $ref: "#/components/examples/400-Validate-ConnectionUuid" InvalidConnectionLocation: $ref: "#/components/examples/400-Invalid-Connection-Location" MandatoryPackageType: $ref: "#/components/examples/400-Mandatory-PackageType" InvalidPackageType: $ref: "#/components/examples/400-Invalid-PackageType" InvalidConnectionPackageType: $ref: "#/components/examples/400-Invalid-Connection-PackageType" MandatoryPackage: $ref: "#/components/examples/400-Mandatory-Package" InvalidPackage: $ref: "#/components/examples/400-Invalid-Package" InvalidConnectionPackage: $ref: "#/components/examples/400-Invalid-Connection-Package" MandatoryPrimaryIP: $ref: "#/components/examples/400-Mandatory-PrimaryIP" InvalidPrimaryIPFormat: $ref: "#/components/examples/400-Invalid-PrimaryIP-Format" ValidatePrimaryIP: $ref: "#/components/examples/400-Validate-PrimaryIP" MandatorySecondaryIP: $ref: "#/components/examples/400-Mandatory-SecondaryIP" InvalidSecondaryIPFormat: $ref: "#/components/examples/400-Invalid-SecondaryIP-Format" ValidateSecondaryIP: $ref: "#/components/examples/400-Validate-SecondaryIP" ValidateSameSubnet: $ref: "#/components/examples/400-Validate-SameSubnet" MandatoryNetworkMask: $ref: "#/components/examples/400-Mandatory-NetworkMask" InvalidNetworkMaskFormat: $ref: "#/components/examples/400-Invalid-NetworkMask-Format" ValidateNetworkMask: $ref: "#/components/examples/400-Validate-NetworkMask" InvalidDefaultGatewayFormat: $ref: "#/components/examples/400-Invalid-DefaultGateway-Format" ValidateDefaultGateway: $ref: "#/components/examples/400-Validate-DefaultGateway" InvalidTimeScale: $ref: "#/components/examples/400-Invalid-TimeScale" InvalidDomain: $ref: "#/components/examples/400-Invalid-Domain" InvalidPriority1: $ref: "#/components/examples/400-Invalid-Priority1" InvalidPriority2: $ref: "#/components/examples/400-Invalid-Priority2" InvalidLogAnnounceInterval: $ref: "#/components/examples/400-Invalid-LogAnnounceInterval" ValidateLogAnnounceIntervalRange: $ref: "#/components/examples/400-Validate-LogAnnounceInterval-Range" InvalidLogSyncInterval: $ref: "#/components/examples/400-Invalid-LogSyncInterval" ValidateLogSyncIntervalRange: $ref: "#/components/examples/400-Validate-LogSyncInterval-Range" InvalidLogDelayReqInterval: $ref: "#/components/examples/400-Invalid-LogDelayReqInterval" ValidateLogDelayReqIntervalRange: $ref: "#/components/examples/400-Validate-LogDelayReqInterval-Range" InvalidTransportMode: $ref: "#/components/examples/400-Invalid-TransportMode" InvalidGrantTime: $ref: "#/components/examples/400-Invalid-GrantTime" ValidateGrantTimeRange: $ref: "#/components/examples/400-Validate-GrantTime-Range" InvalidType: $ref: "#/components/examples/400-Invalid-Type" InvalidId: $ref: "#/components/examples/400-Invalid-Id" InvalidPassword: $ref: "#/components/examples/400-Invalid-Password" ValidatePassword: $ref: "#/components/examples/400-Validate-Password" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" /fabric/v4/timeServices/search: post: tags: - Precision Time summary: Search Time Services description: The API provides capability to get list of user's Time Services using search criteria, including optional filtering, pagination and sorting operationId: searchTimeServices parameters: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/TimeServicesSearchRequest" examples: SearchFilterByStatus: $ref: "#/components/examples/SearchTimeServicesFilterByStatus" SearchFilterByNameAndProtocol: $ref: "#/components/examples/SearchTimeServicesByNameAndProtocol" SearchFilterOrAnd: $ref: "#/components/examples/SearchTimeServicesFilterOrAnd" required: true responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/ServiceSearchResponse" examples: Example: $ref: "#/components/examples/serviceSearchResponse" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/service_400_invalid_sorting" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" "/fabric/v4/timeServices/{serviceId}/connections": get: tags: - Precision Time summary: Get Connection Links description: The API provides capability to get prevision timing service's details operationId: getTimeServicesConnectionsByServiceId parameters: - name: serviceId in: path description: Service UUID required: true schema: $ref: "#/components/schemas/ServiceId" responses: "200": description: Return Time Service Connection content: application/json: schema: $ref: "#/components/schemas/precisionTimeServiceConnectionsResponse" examples: example: $ref: "#/components/examples/serviceConnectionsResponse" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" /fabric/v4/timeServicePackages: get: tags: - Precision Time summary: Get Packages description: The API provides capability to get timing service's packages operationId: getTimeServicesPackages parameters: [] responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/precisionTimeServicePackagesResponse" examples: example: $ref: "#/components/examples/servicePackagesResponse" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" "/fabric/v4/timeServicePackages/{packageCode}": get: tags: - Precision Time summary: Get Package By Code description: The API provides capability to get timing service's package by code operationId: getTimeServicesPackageByCode parameters: - name: packageCode in: path description: Package Code required: true schema: type: string enum: - NTP_STANDARD - NTP_ENTERPRISE - PTP_STANDARD - PTP_ENTERPRISE responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/precisionTimePackageResponse" examples: example: $ref: "#/components/examples/servicePackageResponse" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" "/fabric/v4/marketplaceSubscriptions/{subscriptionId}": get: tags: - Marketplace Subscriptions summary: Get Subscription description: The API provides capability to get subscription operationId: getSubscriptionById parameters: - name: subscriptionId in: path description: Subscription UUID required: true schema: $ref: "#/components/schemas/SubscriptionId" responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/SubscriptionResponse" examples: example: $ref: "#/components/examples/subscription-response" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" /fabric/v4/streams: get: tags: - Streams summary: Get Streams description: This API provides capability to retrieve streams operationId: getStreams parameters: - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/GetAllStreamResponse" examples: Example: $ref: "#/components/examples/stream-get-all-example" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" post: tags: - Streams summary: Create Stream description: This API provides capability to create user's stream operationId: createStreams parameters: [] requestBody: content: application/json: schema: $ref: "#/components/schemas/StreamPostRequest" examples: CreateStream: $ref: "#/components/examples/StreamPostRequestExample" required: true responses: "202": description: Stream object content: application/json: schema: $ref: "#/components/schemas/Stream" examples: StreamSubscriptionResponse: $ref: "#/components/examples/StreamResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" "/fabric/v4/streams/{streamId}": get: tags: - Streams summary: Get Stream description: This API provides capability to get user's stream operationId: getStreamByUuid parameters: - name: streamId in: path description: Stream UUID required: true schema: $ref: "#/components/schemas/StreamId" responses: "200": description: Stream object content: application/json: schema: $ref: "#/components/schemas/Stream" examples: StreamSubscriptionResponse: $ref: "#/components/examples/StreamResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" put: tags: - Streams summary: Update Stream description: This API provides capability to update user's stream operationId: updateStreamByUuid parameters: - name: streamId in: path description: Stream UUID required: true schema: $ref: "#/components/schemas/StreamId" requestBody: content: application/json: schema: $ref: "#/components/schemas/StreamPutRequest" examples: UpdateStream: $ref: "#/components/examples/StreamPutRequestExample" required: true responses: "202": description: Stream object content: application/json: schema: $ref: "#/components/schemas/Stream" examples: StreamResponse: $ref: "#/components/examples/StreamResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" delete: tags: - Streams summary: Delete Stream description: This API provides capability to delete user's stream operationId: deleteStreamByUuid parameters: - name: streamId in: path description: Stream UUID required: true schema: $ref: "#/components/schemas/StreamId" responses: "202": description: Stream object content: application/json: schema: $ref: "#/components/schemas/Stream" examples: StreamSubscriptionResponse: $ref: "#/components/examples/StreamDeleteRequestExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" /fabric/v4/streamAssets/search: post: tags: - Streams summary: Get Assets description: This API provides capability to retrieve stream assets operationId: getStreamsAssets parameters: - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 requestBody: content: application/json: schema: $ref: "#/components/schemas/StreamAssetSearchRequest" examples: SearchAssets: $ref: "#/components/examples/StreamAssetSearchRequestExample" required: true responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/GetAllStreamAssetResponse" examples: Example: $ref: "#/components/examples/stream-asset-get-all-example" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" "/fabric/v4/streams/{streamId}/{asset}/{assetId}": get: tags: - Streams summary: Get Asset description: This API provides capability to get user's assets attached to a stream operationId: getStreamAssetByUuid parameters: - name: assetId in: path description: asset UUID required: true schema: $ref: "#/components/schemas/AssetId_1" - name: asset in: path description: asset required: true schema: $ref: "#/components/schemas/Asset" - name: streamId in: path description: Stream UUID required: true schema: $ref: "#/components/schemas/StreamId" responses: "200": description: Stream asset object content: application/json: schema: $ref: "#/components/schemas/StreamAsset" examples: StreamSubscriptionResponse: $ref: "#/components/examples/StreamConnectionAssetResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" put: tags: - Streams summary: Attach Asset description: This API provides capability to attach an asset to a stream operationId: updateStreamAssetByUuid parameters: - name: assetId in: path description: asset UUID required: true schema: $ref: "#/components/schemas/AssetId_1" - name: asset in: path description: asset required: true schema: $ref: "#/components/schemas/Asset" - name: streamId in: path description: Stream UUID required: true schema: $ref: "#/components/schemas/StreamId" requestBody: content: application/json: schema: $ref: "#/components/schemas/StreamAssetPutRequest" examples: UpdateStream: $ref: "#/components/examples/StreamAssetPutRequestExample" required: true responses: "202": description: Stream object content: application/json: schema: $ref: "#/components/schemas/StreamAsset" examples: StreamAssetResponse: $ref: "#/components/examples/StreamRouterAssetAttachResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" delete: tags: - Streams summary: Detach Asset description: This API provides capability to detach an asset from a stream operationId: deleteStreamAssetByUuid parameters: - name: assetId in: path description: asset UUID required: true schema: $ref: "#/components/schemas/AssetId_1" - name: asset in: path description: asset required: true schema: $ref: "#/components/schemas/Asset" - name: streamId in: path description: Stream UUID required: true schema: $ref: "#/components/schemas/StreamId" responses: "202": description: Stream object content: application/json: schema: $ref: "#/components/schemas/StreamAsset" examples: StreamAssetResponse: $ref: "#/components/examples/StreamRouterAssetDetachResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" "/fabric/v4/streams/{streamId}/subscriptions": get: tags: - Stream Subscriptions summary: Get Subscriptions description: This API provides capability to retrieve stream subscriptions operationId: getStreamSubscriptions parameters: - name: streamId in: path description: Stream UUID required: true schema: $ref: "#/components/schemas/StreamId" - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 responses: "200": description: Successful operation content: application/json: schema: $ref: "#/components/schemas/GetAllStreamSubscriptionResponse" examples: Example: $ref: "#/components/examples/stream-subscription-get-all-example" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" post: tags: - Stream Subscriptions summary: Create Subscription description: This API provides capability to create user's Stream Subscriptions operationId: createStreamSubscriptions parameters: - name: streamId in: path description: Stream UUID required: true schema: $ref: "#/components/schemas/StreamId" requestBody: content: application/json: schema: $ref: "#/components/schemas/StreamSubscriptionPostRequest" examples: CreateStreamSubscription_Splunk_Simple: $ref: "#/components/examples/StreamSubscriptionPostRequestExampleSimpleDefaultSplunk" CreateStreamSubscription_Splunk: $ref: "#/components/examples/StreamSubscriptionPostRequestExampleSplunk" CreateStreamSubscription_Slack: $ref: "#/components/examples/StreamSubscriptionPostRequestExampleSlack" CreateStreamSubscription_Pagerduty: $ref: "#/components/examples/StreamSubscriptionPostRequestExamplePagerduty" CreateStreamSubscription_Datadog: $ref: "#/components/examples/StreamSubscriptionPostRequestExampleDatadog" CreateStreamSubscription_Microsoft_Teams: $ref: "#/components/examples/StreamSubscriptionPostRequestExampleTeams" CreateStreamSubscription_Servicenow: $ref: "#/components/examples/StreamSubscriptionPostRequestExampleServicenow" required: true responses: "202": description: Stream Subscription object content: application/json: schema: $ref: "#/components/schemas/StreamSubscription" examples: StreamSubscriptionResponse: $ref: "#/components/examples/StreamSubscriptionResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" "/fabric/v4/streams/{streamId}/subscriptions/{subscriptionId}": get: tags: - Stream Subscriptions summary: Get Subscription description: This API provides capability to delete user's get Stream Subscriptions operationId: getStreamSubscriptionByUuid parameters: - name: streamId in: path description: Stream UUID required: true schema: $ref: "#/components/schemas/StreamId" - name: subscriptionId in: path description: Stream Subscription UUID required: true schema: $ref: "#/components/schemas/StreamSubscriptionId" responses: "200": description: Stream Subscription object content: application/json: schema: $ref: "#/components/schemas/StreamSubscription" examples: StreamSubscriptionResponse: $ref: "#/components/examples/StreamSubscriptionResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" put: tags: - Stream Subscriptions summary: Update Subscription description: This API provides capability to update user's Stream Subscriptions operationId: updateStreamSubscriptionByUuid parameters: - name: streamId in: path description: Stream UUID required: true schema: $ref: "#/components/schemas/StreamId" - name: subscriptionId in: path description: Stream Subscription UUID required: true schema: $ref: "#/components/schemas/StreamSubscriptionId" requestBody: content: application/json: schema: $ref: "#/components/schemas/StreamSubscriptionPutRequest" examples: UpdateSubscription: $ref: "#/components/examples/StreamSubscriptionPutRequestExample" required: true responses: "202": description: Stream Subscription object content: application/json: schema: $ref: "#/components/schemas/StreamSubscription" examples: StreamSubscriptionResponse: $ref: "#/components/examples/StreamSubscriptionResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" delete: tags: - Stream Subscriptions summary: Delete Subscription description: This API provides capability to delete user's Stream Subscriptions operationId: deleteStreamSubscriptionByUuid parameters: - name: streamId in: path description: Stream UUID required: true schema: $ref: "#/components/schemas/StreamId" - name: subscriptionId in: path description: Stream Subscription UUID required: true schema: $ref: "#/components/schemas/StreamSubscriptionId" responses: "202": description: Stream Subscription object content: application/json: schema: $ref: "#/components/schemas/StreamSubscription" examples: StreamSubscriptionResponse: $ref: "#/components/examples/StreamSubscriptionDeleteResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" "/fabric/v4/streams/{streamId}/alertRules": get: tags: - Stream Alert Rules summary: Get Stream Alert Rules description: This API provides capability to retrieve stream alert rules operationId: getStreamAlertRules parameters: - name: streamId in: path description: Stream UUID required: true schema: $ref: "#/components/schemas/StreamId" - name: offset in: query description: offset required: false schema: type: integer example: 1 - name: limit in: query description: number of records to fetch required: false schema: type: integer example: 10 responses: "200": description: Stream Alert Rules object content: application/json: schema: $ref: "#/components/schemas/StreamAlertRule" examples: GetAllStreamAlertRuleResponse: $ref: "#/components/examples/stream-alert-rules-get-all-example" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" post: tags: - Stream Alert Rules summary: Create Stream Alert Rules description: This API provides capability to create user's Stream Alert Rules operationId: createStreamAlertRules parameters: - name: streamId in: path description: Stream UUID required: true schema: $ref: "#/components/schemas/StreamId" requestBody: content: application/json: schema: $ref: "#/components/schemas/AlertRulePostRequest" examples: CreateStreamAlertRules: $ref: "#/components/examples/StreamAlertRulePostRequestExample" required: true responses: "202": description: Stream Alert Rules object content: application/json: schema: $ref: "#/components/schemas/StreamAlertRule" examples: StreamAlertRuleRequestResponse: $ref: "#/components/examples/StreamAlertRuleResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" "/fabric/v4/streams/{streamId}/alertRules/{alertRuleId}": get: tags: - Stream Alert Rules summary: Get Stream Alert Rules description: This API provides capability to get user's stream alert rules operationId: getStreamAlertRuleByUuid parameters: - name: streamId in: path description: Stream UUID required: true schema: $ref: "#/components/schemas/StreamId" - name: alertRuleId in: path description: alert rule UUID required: true schema: $ref: "#/components/schemas/AlertRuleId" responses: "200": description: Stream Alert Rules object content: application/json: schema: $ref: "#/components/schemas/StreamAlertRule" examples: StreamAlertRuleResponse: $ref: "#/components/examples/StreamAlertRuleResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" put: tags: - Stream Alert Rules summary: Update Stream Alert Rules description: This API provides capability to update a user's stream alert rule operationId: updateStreamAlertRuleByUuid parameters: - name: streamId in: path description: Stream UUID required: true schema: $ref: "#/components/schemas/StreamId" - name: alertRuleId in: path description: alert rule UUID required: true schema: $ref: "#/components/schemas/AlertRuleId" requestBody: content: application/json: schema: $ref: "#/components/schemas/AlertRulePutRequest" examples: UpdateStreamAlertRules: $ref: "#/components/examples/StreamAlertRulePutRequestExample" required: true responses: "202": description: Stream Alert Rules object content: application/json: schema: $ref: "#/components/schemas/StreamAlertRule" examples: StreamAlertRuleRequestResponse: $ref: "#/components/examples/StreamAlertRuleResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "415": description: Unsupported Media Type content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/415" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" delete: tags: - Stream Alert Rules summary: Update Stream Alert Rules description: This API provides capability to delete a user's stream alert rule operationId: deleteStreamAlertRuleByUuid parameters: - name: streamId in: path description: Stream UUID required: true schema: $ref: "#/components/schemas/StreamId" - name: alertRuleId in: path description: alert rule UUID required: true schema: $ref: "#/components/schemas/AlertRuleId" responses: "202": description: Stream Alert Rules object content: application/json: schema: $ref: "#/components/schemas/StreamAlertRule" examples: StreamAlertRuleDeleteResponse: $ref: "#/components/examples/StreamAlertRuleDeleteResponseExample" "400": description: Bad request content: application/json: schema: $ref: "#/components/schemas/ErrorList" "401": description: Unauthorized content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/401" "403": description: Forbidden content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/403" "404": description: Not Found content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/404" "500": description: Internal server error content: application/json: schema: $ref: "#/components/schemas/ErrorList" examples: example: $ref: "#/components/examples/500" components: schemas: CloudEventAssetType: type: string enum: - ports - connections - routers AssetId: type: string description: Asset UUID format: uuid example: 757400f8-d360-11e9-bb65-2a2ae2dbcce6 StartDateTime: type: string description: Start date and time format: date-time example: 2024-07-11T18:06:21Z EndDateTime: type: string description: End date and time format: date-time example: 2024-07-11T18:06:21Z Offset: type: integer description: Pagination offset example: 0 default: 0 Limit: type: integer description: Pagination limit example: 20 default: 20 GetCloudEventsByAssetResponse: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array description: Data returned from the API call. items: $ref: "#/components/schemas/CloudEvent" ErrorList: type: array description: List of Error Message items: $ref: "#/components/schemas/Error" CloudEventId: type: string description: Cloud Event UUID format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 CloudEvent: type: object properties: spec: type: string description: Cloud Event Open Telemetry specification readOnly: true source: type: string description: Cloud Event source id: type: string description: Cloud Event identifier format: uuid type: type: string description: Equinix supported event type subject: type: string description: Cloud Event subject dataschema: type: string description: Cloud Event dataschema reference datacontenttype: type: string description: Cloud Event data content type severitynumber: type: string description: Cloud Event severity number severitytext: type: string description: Cloud Event severity text equinixproject: type: string description: Equinix project identifier format: uuid authtype: type: string description: Cloud Event auth type authid: type: string description: Cloud Event user identifier data: $ref: "#/components/schemas/CloudEventData" description: Cloud Event object CloudEventSearchRequest: type: object properties: filter: $ref: "#/components/schemas/CloudEventFilters" pagination: $ref: "#/components/schemas/PaginationRequest" sort: type: array items: $ref: "#/components/schemas/CloudEventFilters" description: Search requests containing criteria CloudEventFilters: type: object properties: and: type: array items: $ref: "#/components/schemas/CloudEventFilter" CloudEventFilter: type: object anyOf: - $ref: "#/components/schemas/CloudEventSimpleExpression" CloudEventSimpleExpression: type: object properties: property: type: string description: | Possible field names to use on filters: * `/subject` - Cloud Event subject description * `/type` - Cloud Event type * `/time` - Time of Cloud Events example: /subject operator: type: string description: | Possible operators to use on filters: * `=` - equal * `>` - greater than * `>=` - greater than or equal to * `<` - less than * `<=` - less than or equal to * `BETWEEN` - between * `IN` - in example: = values: type: array items: type: string example: equinix.fabric.port.status.* ConnectionPostRequest: required: - aSide - bandwidth - name - notifications - type - zSide type: object properties: type: $ref: "#/components/schemas/ConnectionType" name: type: string description: Customer-provided connection name order: $ref: "#/components/schemas/Order" notifications: type: array description: Preferences for notifications on connection configuration or status changes items: $ref: "#/components/schemas/SimplifiedNotification" bandwidth: maximum: 50000 minimum: 0 type: integer description: Connection bandwidth in Mbps geoScope: $ref: "#/components/schemas/GeoScopeType" redundancy: $ref: "#/components/schemas/ConnectionRedundancy" aSide: $ref: "#/components/schemas/ConnectionSide" zSide: $ref: "#/components/schemas/ConnectionSide" project: $ref: "#/components/schemas/Project" additionalInfo: type: array description: Connection additional information items: $ref: "#/components/schemas/ConnectionSideAdditionalInfo" marketplaceSubscription: $ref: "#/components/schemas/marketplaceSubscription" endCustomer: $ref: "#/components/schemas/EndCustomer" description: Create connection post request Connection: required: - aSide - bandwidth - name - type - zSide type: object properties: href: type: string description: Connection URI format: uri readOnly: true type: $ref: "#/components/schemas/ConnectionType" uuid: type: string description: Equinix-assigned connection identifier name: type: string description: Customer-provided connection name description: type: string description: Customer-provided connection description state: $ref: "#/components/schemas/ConnectionState" change: $ref: "#/components/schemas/Change" operation: $ref: "#/components/schemas/ConnectionOperation" order: $ref: "#/components/schemas/Order" notifications: type: array description: Preferences for notifications on connection configuration or status changes items: $ref: "#/components/schemas/SimplifiedNotification" account: $ref: "#/components/schemas/SimplifiedAccount" changeLog: $ref: "#/components/schemas/Changelog" bandwidth: maximum: 10000 minimum: 0 type: integer description: Connection bandwidth in Mbps geoScope: $ref: "#/components/schemas/GeoScopeType" redundancy: $ref: "#/components/schemas/ConnectionRedundancy" isRemote: type: boolean description: Connection property derived from access point locations direction: $ref: "#/components/schemas/ConnectionDirection" aSide: $ref: "#/components/schemas/ConnectionSide" zSide: $ref: "#/components/schemas/ConnectionSide" marketplaceSubscription: $ref: "#/components/schemas/marketplaceSubscription" additionalInfo: type: array description: Connection additional information items: $ref: "#/components/schemas/ConnectionSideAdditionalInfo" project: $ref: "#/components/schemas/Project" description: Connection specification ConnectionId: type: string description: Connection UUID example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 ConnectionDirection: type: string description: Connection directionality from the requester point of view enum: - INTERNAL - INCOMING - OUTGOING VirtualCircuitId: type: string description: Virtual Circuit UUID ConnectionUpdateRequest: minItems: 1 type: array description: Connection Update Request items: $ref: "#/components/schemas/ConnectionChangeOperation" ConnectionActionRequest: required: - type type: object properties: type: $ref: "#/components/schemas/Actions" description: type: string description: Connection rejection reason detail data: $ref: "#/components/schemas/ConnectionAcceptanceData" description: Connection action request ConnectionAction: required: - data - href - type - uuid type: object properties: type: $ref: "#/components/schemas/Actions" href: type: string description: Connection action URI format: uri readOnly: true uuid: type: string description: Equinix-assigned connection identifier description: type: string description: Connection rejection reason detail data: $ref: "#/components/schemas/ConnectionAcceptanceData" changeLog: $ref: "#/components/schemas/Changelog" description: Connection action ConnectionRouteSearchRequest: type: object properties: filter: $ref: "#/components/schemas/ConnectionRouteEntryFilters" pagination: $ref: "#/components/schemas/PaginationRequest" sort: type: array items: $ref: "#/components/schemas/ConnectionRouteSortCriteria" description: Search requests containing criteria ConnectionRouteEntryFilters: type: object properties: and: maxItems: 8 type: array items: $ref: "#/components/schemas/ConnectionRouteEntryFilter" ConnectionRouteEntryFilter: type: object anyOf: - $ref: "#/components/schemas/ConnectionRouteEntrySimpleExpression" - $ref: "#/components/schemas/ConnectionRouteEntryOrFilter" ConnectionRouteEntrySimpleExpression: type: object properties: property: type: string description: | Possible field names to use on filters: * `/type` - Route table entry type * `/state` - Route table entry state * `/prefix` - Route table entry prefix * `/nextHop` - Route table entry nextHop * `/*` - all-category search example: /type operator: type: string description: | Possible operators to use on filters: * `=` - equal * `!=` - not equal * `>` - greater than * `>=` - greater than or equal to * `<` - less than * `<=` - less than or equal to * `[NOT] BETWEEN` - (not) between * `[NOT] LIKE` - (not) like * `[NOT] IN` - (not) in * `~*` - case-insensitive like example: = values: type: array items: type: string example: IPv4_BGP_ROUTE ConnectionRouteEntryOrFilter: type: object properties: or: maxItems: 3 type: array items: $ref: "#/components/schemas/ConnectionRouteEntrySimpleExpression" ConnectionRouteSortCriteria: type: object properties: direction: $ref: "#/components/schemas/ConnectionRouteEntrySortDirection" property: $ref: "#/components/schemas/ConnectionRouteEntrySortBy" ConnectionRouteEntrySortDirection: type: string description: Sorting direction default: DESC enum: - DESC - ASC ConnectionRouteEntrySortBy: type: string description: Possible field names to use on sorting default: /changeLog/updatedDateTime enum: - /changeLog/createdDateTime - /changeLog/updatedDateTime - /med - /connection/name - /type - /prefix - /nextHop ConnectionRouteTableEntrySearchResponse: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array description: Data returned from the API call. items: $ref: "#/components/schemas/ConnectionRouteTableEntry" GetResponse: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array description: List of Routing Protocols items: $ref: "#/components/schemas/RoutingProtocolData" RoutingProtocolBase: type: object properties: type: type: string description: Routing protocol type enum: - BGP - DIRECT oneOf: - $ref: "#/components/schemas/RoutingProtocolBGPType" - $ref: "#/components/schemas/RoutingProtocolDirectType" RoutingProtocolBGPType: required: - type type: object properties: type: type: string description: Routing protocol type enum: - BGP name: type: string example: My-BGP-route-1 bgpIpv4: $ref: "#/components/schemas/BGPConnectionIpv4" bgpIpv6: $ref: "#/components/schemas/BGPConnectionIpv6" customerAsn: type: integer description: Customer asn format: int64 equinixAsn: type: integer description: Equinix asn format: int64 bgpAuthKey: type: string description: BGP authorization key asOverrideEnabled: type: boolean description: Enable AS number override bfd: $ref: "#/components/schemas/RoutingProtocolBFD" RoutingProtocolDirectType: required: - type type: object properties: type: type: string description: Routing protocol type enum: - DIRECT name: type: string example: My-direct-route-1 directIpv4: $ref: "#/components/schemas/DirectConnectionIpv4" directIpv6: $ref: "#/components/schemas/DirectConnectionIpv6" RoutingProtocolData: type: object properties: type: type: string description: Routing protocol type enum: - BGP - DIRECT oneOf: - $ref: "#/components/schemas/RoutingProtocolBGPData" - $ref: "#/components/schemas/RoutingProtocolDirectData" ConnectionRoutingProtocolPostRequest: type: object properties: data: type: array description: Connection routing protocol configuration items: $ref: "#/components/schemas/RoutingProtocolBase" description: Create connection routing protocolpost request RoutingProtocolId: type: string description: Routing Protocol UUID format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 ConnectionRoutingProtocolPatchRequest: minItems: 1 type: array description: Patch connection routing protocol request items: $ref: "#/components/schemas/ConnectionChangeOperation" BGPActionsBulkData: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array items: $ref: "#/components/schemas/BGPActionData" description: List of BGP Actions BGPActionRequest: required: - type type: object properties: type: $ref: "#/components/schemas/BGPActions" description: BGP action request BGPActionData: type: object properties: href: type: string description: Routing Protocol URI format: uri example: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routingProtocols/69762051-85ed-4d13-b6b4-e32e93c672b5/actions uuid: type: string description: Routing protocol identifier format: uuid example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 type: $ref: "#/components/schemas/BGPActions" description: type: string description: BGP action description state: $ref: "#/components/schemas/BGPActionStates" changelog: $ref: "#/components/schemas/Changelog" ActionId: type: string description: BGP Action UUID format: uuid example: 86534014-34b4-53f6-45d6-4b94a92d8623 ChangeId: type: string description: Routing Protocol Change UUID format: uuid example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 RoutingProtocolChangeData: type: object properties: status: type: string description: Current outcome of the change flow enum: - COMPLETED - FAILED - REQUESTED createdBy: type: string description: Created by User Key createdDateTime: type: string description: Set when change flow starts format: date-time updatedBy: type: string description: Updated by User Key updatedDateTime: type: string description: Set when change object is updated format: date-time information: type: string description: Additional information data: $ref: "#/components/schemas/RoutingProtocolChangeOperation" description: Current state of latest Routing Protocol change allOf: - $ref: "#/components/schemas/RoutingProtocolChange" RoutingProtocolChangeDataResponse: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array items: $ref: "#/components/schemas/RoutingProtocolChangeData" description: List of network changes SearchRequest: type: object properties: filter: $ref: "#/components/schemas/Expression" pagination: $ref: "#/components/schemas/PaginationRequest" sort: type: array items: $ref: "#/components/schemas/SortCriteria" description: Search requests containing criteria Expression: type: object properties: and: $ref: "#/components/schemas/Expressions" or: $ref: "#/components/schemas/Expressions" property: $ref: "#/components/schemas/SearchFieldName" operator: type: string enum: - = - "!=" - ">" - ">=" - < - <= - BETWEEN - NOT BETWEEN - LIKE - NOT LIKE - IN - NOT IN - IS NOT NULL - IS NULL values: type: array items: type: string Expressions: type: array items: $ref: "#/components/schemas/Expression" SearchFieldName: type: string description: Possible field names to use on filters enum: - /isRemote - /name - /uuid - /type - /geoScope - /account/orgId - /aSide/accessPoint/account/accountName - /aSide/accessPoint/account/accountNumber - /aSide/accessPoint/router/uuid - /aSide/accessPoint/linkProtocol/vlanCTag - /aSide/accessPoint/linkProtocol/vlanSTag - /aSide/accessPoint/linkProtocol/vlanTagMin - /aSide/accessPoint/linkProtocol/vlanTagMax - /aSide/accessPoint/location/metroCode - /aSide/accessPoint/location/metroName - /aSide/accessPoint/name - /aSide/accessPoint/port/uuid - /aSide/accessPoint/port/name - /aSide/accessPoint/type - /aSide/accessPoint/virtualDevice/name - /aSide/accessPoint/virtualDevice/uuid - /aSide/serviceToken/uuid - /change/status - /operation/equinixStatus - /operation/providerStatus - /project/projectId - /redundancy/group - /redundancy/priority - /zSide/accessPoint/account/accountName - /zSide/accessPoint/authenticationKey - /zSide/accessPoint/linkProtocol/vlanCTag - /zSide/accessPoint/linkProtocol/vlanSTag - /zSide/accessPoint/linkProtocol/vlanTagMin - /zSide/accessPoint/linkProtocol/vlanTagMax - /zSide/accessPoint/location/metroCode - /zSide/accessPoint/location/metroName - /zSide/accessPoint/name - /zSide/accessPoint/port/uuid - /zSide/accessPoint/network/uuid - /zSide/accessPoint/port/name - /zSide/accessPoint/profile/uuid - /zSide/accessPoint/type - /zSide/accessPoint/virtualDevice/name - /zSide/accessPoint/virtualDevice/uuid - /zSide/serviceToken/uuid - /zSide/internetAccess/uuid - "*" SortCriteria: type: object properties: direction: $ref: "#/components/schemas/SortDirection" property: $ref: "#/components/schemas/SortBy" ConnectionSearchResponse: type: object properties: pagination: $ref: "#/components/schemas/Pagination" sort: type: array items: $ref: "#/components/schemas/SortCriteriaResponse" data: type: array items: $ref: "#/components/schemas/Connection" description: List of connections FilterBody: type: object properties: filter: $ref: "#/components/schemas/SearchExpression" description: Search requests containing criteria SearchExpression: type: object properties: and: $ref: "#/components/schemas/SearchExpressions" or: $ref: "#/components/schemas/SearchExpressions" property: type: string operator: type: string enum: - = - "!=" - ">" - ">=" - < - <= - BETWEEN - NOT BETWEEN - LIKE - NOT LIKE - IN - NOT IN - IS NOT NULL - IS NULL values: type: array items: type: string SearchExpressions: type: array items: $ref: "#/components/schemas/SearchExpression" PriceSearchResponse: type: object properties: data: type: array items: $ref: "#/components/schemas/Price" pagination: $ref: "#/components/schemas/Pagination" PriceErrorList: type: array items: $ref: "#/components/schemas/PriceError" PriceError: required: - errorCode - errorMessage type: object properties: errorCode: type: string enum: - EQ-3038010 - EQ-3038022 - EQ-3038030 errorMessage: type: string enum: - Validation failure - Invalid value - Internal Server Error correlationId: type: string details: type: string help: type: string additionalInfo: type: array items: $ref: "#/components/schemas/PriceError_additionalInfo" description: Error with details discriminator: propertyName: errorCode PortUUID: type: string description: Port UUID format: uuid Statistics: type: object properties: startDateTime: type: string description: Start and duration of the statistical analysis interval. format: date-time example: 2020-11-06T07:00:00Z endDateTime: type: string description: End and duration of the statistical analysis interval. format: date-time example: 2020-11-06T07:00:00Z viewPoint: type: string description: Point of view for connection metrics - aSide or zSide enum: - aSide - zSide bandwidthUtilization: $ref: "#/components/schemas/BandwidthUtilization" description: This API provides service-level traffic metrics so that you can view access and gather key information required to manage service subscription sizing and capacity. BandwidthUtilization: type: object properties: unit: type: string description: Aggregated data transfer capacity. Possible values- Mbps, megabits (1 million bits) per second; Gbps, gigabits (1 billion bits) per second. enum: - Mbps metricInterval: type: string description: An interval formatted value, indicating the time-interval the metric objects within the response represent inbound: $ref: "#/components/schemas/Direction" outbound: $ref: "#/components/schemas/Direction" description: Bandwidth utilization statistics (octet counters-based) Direction: type: object properties: max: type: number description: Max bandwidth within request time range, represented in units specified by response "units" field format: float mean: type: number description: Mean bandwidth within request time range, represented in units specified by response "units" field format: float metrics: type: array description: Bandwidth utilization statistics for a specified interval. items: $ref: "#/components/schemas/Metrics" description: Directional statistics Metrics: type: object properties: intervalEndTimestamp: type: string description: Interval end timestamp format: date-time example: 2020-11-06T07:00:00Z max: type: number description: Max bandwidth within statistics object time interval, represented in units specified by response "units" field format: float mean: type: number description: Mean bandwidth within statistics object time interval, represented in units specified by response "units" field format: float description: Bandwidth utilization statistics for a specified interval. viewPoint: type: string description: viewPoint enum: - aSide - zSide ServiceProfiles: type: object properties: data: type: array items: $ref: "#/components/schemas/ServiceProfile" pagination: $ref: "#/components/schemas/Pagination" description: Service Profiles ServiceProfileRequest: required: - description - name - type type: object properties: project: $ref: "#/components/schemas/Project" description: | Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information and one or more sets of access points (a set per each access point type) fulfilling the provider service. allOf: - $ref: "#/components/schemas/SimplifiedServiceProfile" SimplifiedServiceProfile: type: object properties: href: type: string description: Service Profile URI response attribute format: uri readOnly: true type: $ref: "#/components/schemas/ServiceProfileTypeEnum" name: maxLength: 50 type: string description: Customer-assigned service profile name example: Sample Service Profile uuid: type: string description: Equinix-assigned service profile identifier format: uuid description: type: string description: User-provided service description should be of maximum length 375 example: offering connectivity to my-network notifications: type: array description: Recipients of notifications on service profile change items: $ref: "#/components/schemas/SimplifiedNotification" tags: $ref: "#/components/schemas/Tags" visibility: $ref: "#/components/schemas/ServiceProfileVisibilityEnum" allowedEmails: type: array items: type: string format: email accessPointTypeConfigs: minItems: 1 type: array items: $ref: "#/components/schemas/ServiceProfileAccessPointType" customFields: type: array items: $ref: "#/components/schemas/CustomField" marketingInfo: $ref: "#/components/schemas/MarketingInfo" ports: type: array items: $ref: "#/components/schemas/ServiceProfileAccessPointCOLO" virtualDevices: type: array items: $ref: "#/components/schemas/ServiceProfileAccessPointVD" metros: type: array description: Derived response attribute. items: $ref: "#/components/schemas/ServiceMetro" selfProfile: type: boolean description: response attribute indicates whether the profile belongs to the same organization as the api-invoker. projectId: type: string description: | Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information and one or more sets of access points (a set per each access point type) fulfilling the provider service. Tags: type: array items: type: string ServiceProfileAccessPointType: type: object description: Access Point Type oneOf: - $ref: "#/components/schemas/ServiceProfileAccessPointTypeCOLO" - $ref: "#/components/schemas/ServiceProfileAccessPointTypeVD" ServiceProfileAccessPointTypeCOLO: required: - type type: object properties: uuid: type: string type: $ref: "#/components/schemas/ServiceProfileAccessPointTypeEnum" supportedBandwidths: $ref: "#/components/schemas/Bandwidths" allowRemoteConnections: type: boolean description: Setting to allow or prohibit remote connections to the service profile. example: true default: false allowCustomBandwidth: type: boolean description: Setting to enable or disable the ability of the buyer to customize the bandwidth. example: true default: false bandwidthAlertThreshold: type: number description: percentage of port bandwidth at which an allocation alert is generated - missing on wiki. allowBandwidthAutoApproval: type: boolean description: Setting to enable or disable the ability of the buyer to change connection bandwidth without approval of the seller. default: false allowBandwidthUpgrade: type: boolean description: Availability of a bandwidth upgrade. The default is false. linkProtocolConfig: $ref: "#/components/schemas/ServiceProfileLinkProtocolConfig" enableAutoGenerateServiceKey: type: boolean description: for verizon only. connectionRedundancyRequired: type: boolean description: Mandate redundant connections example: true default: false apiConfig: $ref: "#/components/schemas/ApiConfig" connectionLabel: type: string description: custom name for "Connection" authenticationKey: $ref: "#/components/schemas/AuthenticationKey" metadata: $ref: "#/components/schemas/ServiceProfileMetadata" description: Colo Access Point Type ServiceProfileAccessPointTypeEnum: type: string description: Access point type enum: - VD - COLO Bandwidths: type: array items: $ref: "#/components/schemas/Bandwidth" Bandwidth: type: integer description: speed in Mbps example: 50 ServiceProfileLinkProtocolConfig: type: object properties: encapsulationStrategy: type: string description: was tagType - missing on wiki enum: - CTAGED - BOTH - NAMED namedTags: maxItems: 64 type: array items: type: string vlanCTagLabel: type: string description: was ctagLabel reuseVlanSTag: type: boolean example: true default: false encapsulation: type: string description: Port encapsulation - Derived response attribute. Ignored on request payloads. enum: - QINQ - DOT1Q - UNTAGGED description: Configuration for dot1q to qinq translation support ApiConfig: type: object properties: apiAvailable: type: boolean description: Setting indicating whether the API is available (true) or not (false). example: true default: false integrationId: type: string equinixManagedPort: type: boolean description: Setting indicating that the port is managed by Equinix (true) or not (false). example: true default: false equinixManagedVlan: type: boolean description: Setting indicating that the VLAN is managed by Equinix (true) or not (false). example: true default: false allowOverSubscription: type: boolean description: | Setting showing that oversubscription support is available (true) or not (false). The default is false. Oversubscription is the sale of more than the available network bandwidth. This practice is common and legitimate. After all, many customers use less bandwidth than they've purchased. And network users don't consume bandwidth all at the same time. The leftover bandwidth can be sold to other customers. When demand surges, operational and engineering resources can be shifted to accommodate the load. example: false default: false overSubscriptionLimit: maximum: 20 minimum: 1 type: integer description: A cap on oversubscription. example: 1 default: 1 bandwidthFromApi: type: boolean default: false description: Configuration for API based Integration for Service Profile AuthenticationKey: type: object properties: required: type: boolean example: true default: false label: type: string example: Service Key description: type: string example: description for the authentication key description: Authentication Key Support and Customization ServiceProfileMetadata: type: object properties: props: type: string regEx: type: string regExMsg: type: string vlanRangeMaxValue: type: integer vlanRangeMinValue: type: integer maxQinq: type: string maxDot1q: type: integer variableBilling: type: boolean globalOrganization: type: string limitAuthKeyConn: type: boolean allowSecondaryLocation: type: boolean redundantProfileId: type: string allowVcMigration: type: boolean connectionEditable: type: boolean releaseVlan: type: boolean maxConnectionsOnPort: type: integer portAssignmentStrategy: type: string eqxManagedPort: type: boolean connectionNameEditable: type: boolean description: Metadata. Response attribute. Ignored on request payload. ServiceProfileAccessPointTypeVD: required: - type type: object properties: uuid: type: string type: $ref: "#/components/schemas/ServiceProfileAccessPointTypeEnum" supportedBandwidths: $ref: "#/components/schemas/Bandwidths" allowRemoteConnections: type: boolean description: Allow remote connections to Service Profile example: true allowCustomBandwidth: type: boolean example: true additionalProperties: false description: VirtualDevice Access Point Type CustomField: required: - dataType - isRequired - label properties: label: type: string example: Account Number description: type: string example: Provide a valid account number required: type: boolean example: true dataType: type: string enum: - STRING - LIST - NUMBER options: type: array items: type: string captureInEmail: type: boolean description: capture this field as a part of email notification description: Define Custom Attributes MarketingInfo: type: object properties: logo: type: string description: Logo file name promotion: type: boolean description: Profile promotion on marketplace processSteps: maxItems: 3 type: array items: $ref: "#/components/schemas/ProcessStep" ProcessStep: type: object properties: title: type: string description: Service profile custom step title subTitle: type: string description: Service profile custom step sub title description: type: string description: Service profile custom step description description: Definition of customized step while making connection ServiceProfileAccessPointCOLO: required: - type - uuid type: object properties: type: type: string enum: - XF_PORT uuid: type: string format: uuid example: 94662143-e21b-4098-bfcf-e9416f47eae1 location: $ref: "#/components/schemas/SimplifiedLocation" sellerRegion: type: string sellerRegionDescription: type: string crossConnectId: type: string description: Colo Access Point ServiceProfileAccessPointVD: required: - type - uuid type: object properties: type: type: string enum: - VD uuid: type: string format: uuid example: 94662143-e21b-4098-bfcf-e9416f47eae1 location: $ref: "#/components/schemas/SimplifiedLocation" interfaceUuid: type: string format: uuid example: 94662143-e21b-4098-bfcf-e9416f47eae1 description: Virtual Device Point ServiceMetro: type: object properties: code: type: string description: metro code name: type: string description: metro name vcBandwidthMax: type: integer description: max VC speed supported in Mbps ibxs: type: array items: type: string description: ibx codes inTrail: type: boolean displayName: type: string description: service metro display name sellerRegions: type: object additionalProperties: type: string ServiceProfile: type: object properties: state: $ref: "#/components/schemas/ServiceProfileStateEnum" account: description: Seller Account for Service Profile. allOf: - $ref: "#/components/schemas/SimplifiedAccount" - type: object project: $ref: "#/components/schemas/Project" changeLog: description: Seller Account for Service Profile. allOf: - $ref: "#/components/schemas/Changelog" - type: object description: | Service Profile is a software definition for a named provider service and it's network connectivity requirements. This includes the basic marketing information and one or more sets of access points (a set per each access point type) fulfilling the provider service. allOf: - $ref: "#/components/schemas/SimplifiedServiceProfile" ServiceProfileSearchRequest: type: object properties: filter: $ref: "#/components/schemas/ServiceProfileFilter" pagination: $ref: "#/components/schemas/PaginationRequest" sort: type: array items: $ref: "#/components/schemas/ServiceProfileSortCriteria" description: Search requests containing criteria ServiceProfileFilter: type: object anyOf: - $ref: "#/components/schemas/ServiceProfileSimpleExpression" - $ref: "#/components/schemas/ServiceProfileAndFilter" ServiceProfileSimpleExpression: type: object properties: property: type: string description: | Possible field names to use on filters: * `/name` - Service Profile name * `/uuid` - Service Profile uuid * `/state` - Service Profile status * `/metros/code` - Service Profile metro code * `/visibility` - Service Profile package * `/type` - Service Profile package * `/project/projectId` - Service Profile project id example: /name operator: type: string description: | Possible operators to use on filters: * `=` - equal example: = values: type: array items: type: string example: ServiceProfile-1 ServiceProfileAndFilter: type: object properties: and: type: array items: $ref: "#/components/schemas/ServiceProfileSimpleExpression" ServiceProfileSortCriteria: type: object properties: direction: $ref: "#/components/schemas/ServiceProfileSortDirection" property: $ref: "#/components/schemas/ServiceProfileSortBy" ServiceProfileSortDirection: type: string description: Sorting direction default: DESC enum: - DESC - ASC ServiceProfileSortBy: type: string description: Possible field names to use on sorting default: /changeLog/updatedDateTime enum: - /name - /state - /changeLog/createdDateTime - /changeLog/updatedDateTime ServiceProfileId: type: string description: Service Profile UUID format: uuid JsonPatch: type: array items: $ref: "#/components/schemas/JsonPatchOperation" JsonPatchOperation: type: object description: Service Profile Access Points oneOf: - $ref: "#/components/schemas/AddOperation" - $ref: "#/components/schemas/RemoveOperation" - $ref: "#/components/schemas/ReplaceOperation" AddOperation: required: - op - path - value type: object properties: op: $ref: "#/components/schemas/OpEnum" path: $ref: "#/components/schemas/Path" value: type: object description: value to add description: Add Sub-Resource to the existing model OpEnum: type: string description: the operation to be performed enum: - add - remove - replace Path: type: string description: A JSON Pointer path. RemoveOperation: required: - op - path type: object properties: op: $ref: "#/components/schemas/OpEnum" path: $ref: "#/components/schemas/Path" description: Remove sub-resource from an existing model ReplaceOperation: required: - op - path - value type: object properties: op: $ref: "#/components/schemas/OpEnum" path: $ref: "#/components/schemas/Path" value: type: object description: value to replace with description: Replace attribute value or sub-resource in the existing model ServiceMetros: type: object properties: data: type: array items: $ref: "#/components/schemas/ServiceMetro" pagination: $ref: "#/components/schemas/Pagination" description: Service Profile Metros ServiceTokenUUID: type: string description: Service Token UUID format: uuid ServiceToken: type: object properties: type: $ref: "#/components/schemas/ServiceTokenType" href: type: string description: An absolute URL that is the subject of the link's context. format: uri readOnly: true expiry: type: integer deprecated: true uuid: type: string description: Equinix-assigned service token identifier format: uuid issuerSide: type: string description: information about token side deprecated: true name: type: string description: Customer-provided service token name description: type: string description: Customer-provided service token description expirationDateTime: type: string description: Expiration date and time of the service token. format: date-time example: 2020-11-06T07:00:00Z connection: $ref: "#/components/schemas/ServiceTokenConnection" state: $ref: "#/components/schemas/ServiceTokenState" notifications: type: array description: Service token related notifications items: $ref: "#/components/schemas/SimplifiedNotification" account: $ref: "#/components/schemas/SimplifiedAccount" changelog: $ref: "#/components/schemas/Changelog" project: $ref: "#/components/schemas/Project" description: Create Service Tokens (v4) generates Equinix Fabric service tokens. These tokens authorize users to access protected resources and services. The tokens remove sensitive content from the environment, rather than just masking it, making the protected data impossible to unencrypt or decrypt. Resource owners can distribute the tokens to trusted partners and vendors, allowing selected third parties to work directly with Equinix network assets. ServiceTokenUpdateRequest: minItems: 1 type: array description: Service Token Update Request items: $ref: "#/components/schemas/ServiceTokenChangeOperation" ServiceTokens: type: object properties: data: type: array description: List of Service Tokens items: $ref: "#/components/schemas/ServiceToken" pagination: $ref: "#/components/schemas/Pagination" description: Service tokens authorize a user to access protected resources and services available on the Equinix Fabric network. The owner of the resources can distribute service tokens to third-party users (trusted partners and vendors), allowing them to directly access and work with the resources on the network without involving the resource owners. ServiceTokenActionRequest: required: - type type: object properties: type: $ref: "#/components/schemas/ServiceTokenActions" description: Service Token action request ServiceTokenSearchRequest: type: object properties: filter: $ref: "#/components/schemas/ServiceTokenSearchExpression" pagination: $ref: "#/components/schemas/PaginationRequest" description: Search requests containing criteria ServiceTokenSearchExpression: type: object properties: and: $ref: "#/components/schemas/ServiceTokenSearchExpressions" property: $ref: "#/components/schemas/ServiceTokenSearchFieldName" operator: type: string enum: - = values: type: array items: type: string ServiceTokenSearchExpressions: type: array items: $ref: "#/components/schemas/ServiceTokenSearchExpression" ServiceTokenSearchFieldName: type: string description: Possible field names to use on filters enum: - /uuid - /state - /name - /project/projectId Presence: type: string description: Presence enum: - MY_PORTS MetroResponse: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array description: List of Fabric Metros. items: $ref: "#/components/schemas/Metro" description: GET Metros retrieves all Equinix? Fabric? metros, as well as latency data for each location.This performance data helps network planning engineers and administrators make strategic decisions about port locations and traffic routes. Metro: type: object properties: href: type: string description: The Canonical URL at which the resource resides. type: type: string description: Indicator of a Fabric Metro code: type: string description: Code Assigned to an Equinix IBX data center in a specified metropolitan area. region: type: string description: Board geographic area in which the data center is located name: type: string description: Name of the region in which the data center is located. equinixAsn: type: integer description: Autonomous system number (ASN) for a specified Fabric metro. The ASN is a unique identifier that carries the network routing protocol and exchanges that data with other internal systems via border gateway protocol. format: int64 localVCBandwidthMax: type: integer description: This field holds Max Connection speed with in the metro format: int64 geoCoordinates: $ref: "#/components/schemas/GeoCoordinates" connectedMetros: type: array items: $ref: "#/components/schemas/ConnectedMetro" geoScopes: type: array description: List of supported geographic boundaries of a Fabric Metro. items: $ref: "#/components/schemas/GeoScopeType" description: GET Metros retrieves all Equinix? Fabric? metros, as well as latency data for each location.This performance data helps network planning engineers and administrators make strategic decisions about port locations and traffic routes. GeoCoordinates: type: object properties: latitude: type: number description: Latitude of a Fabric Metro format: double longitude: type: number description: Longitude of a Fabric Metro format: double description: Geographic location data of Fabric Metro ConnectedMetro: type: object properties: href: type: string description: The Canonical URL at which the resource resides. code: type: string description: Code assigned to an Equinix International Business Exchange (IBX) data center in a specified metropolitan area. avgLatency: type: number description: Average latency (in milliseconds[ms]) between two specified metros. remoteVCBandwidthMax: type: integer description: This field holds the Max Connection speed with connected metros format: int64 description: Arrays of objects containing latency data for the specified metros GeoScopeType: type: string description: Geographic boundary types enum: - CANADA - CONUS - JAPAN MetroErrorList: type: array items: $ref: "#/components/schemas/MetroError" MetroError: required: - errorCode - errorMessage type: object properties: errorCode: type: string enum: - EQ-3036001 - EQ-3036013 - EQ-3036030 - EQ-3036100 errorMessage: type: string enum: - Unauthorized - Invalid Query Parameter - Invalid Path Parameter - Invalid Query or Path Parameter - Internal Server Error - Metro Not Found correlationId: type: string details: type: string help: type: string additionalInfo: type: array items: $ref: "#/components/schemas/PriceError_additionalInfo" description: Error with details discriminator: propertyName: errorCode MetroCode: type: string description: Metro Code AllPortsResponse: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array description: GET All User Port Across Fabric Metros items: $ref: "#/components/schemas/Port" description: GET All User Port Across Fabric Metros Port: type: object properties: href: type: string description: Equinix assigned response attribute for an absolute URL that is the subject of the link's context. format: uri readOnly: true type: $ref: "#/components/schemas/PortType" id: type: integer description: Equinix assigned response attribute for Port Id uuid: type: string description: Equinix assigned response attribute for port identifier format: uuid name: type: string description: Equinix assigned response attribute for Port name description: type: string description: Equinix assigned response attribute for Port description physicalPortsSpeed: minimum: 0 type: integer description: Physical Ports Speed in Mbps connectionsCount: minimum: 0 type: integer description: Equinix assigned response attribute for Connection count physicalPortsType: type: string description: Physical Ports Type enum: - 1000BASE_LX - 10GBASE_LR - 100GBASE_LR4 - 10GBASE_ER - 1000BASE_SX physicalPortsCount: type: integer connectivitySourceType: type: string description: Port connectivity type enum: - COLO - BMMR - REMOTE bmmrType: type: string enum: - SELF - EQUINIX project: $ref: "#/components/schemas/Project" state: $ref: "#/components/schemas/PortState" order: $ref: "#/components/schemas/PortOrder" operation: allOf: - $ref: "#/components/schemas/PortOperation" account: $ref: "#/components/schemas/SimplifiedAccount" change: $ref: "#/components/schemas/PortChange" changeLog: $ref: "#/components/schemas/Changelog" serviceType: type: string description: Port service Type deprecated: true enum: - EPL - MSP bandwidth: minimum: 0 type: integer description: Equinix assigned response attribute for Port bandwidth in Mbps deprecated: true availableBandwidth: minimum: 0 type: integer description: Equinix assigned response attribute for Port available bandwidth in Mbps usedBandwidth: minimum: 0 type: integer description: Equinix assigned response attribute for Port used bandwidth in Mbps location: $ref: "#/components/schemas/SimplifiedLocation" device: $ref: "#/components/schemas/PortDevice" interface: $ref: "#/components/schemas/PortInterface" demarcationPointIbx: type: string description: A-side/Equinix ibx tetherIbx: type: string description: z-side/Equinix ibx demarcationPoint: $ref: "#/components/schemas/PortDemarcationPoint" redundancy: $ref: "#/components/schemas/PortRedundancy" encapsulation: $ref: "#/components/schemas/PortEncapsulation" lagEnabled: type: boolean description: If LAG enabled lag: allOf: - $ref: "#/components/schemas/PortLag" asn: type: integer description: Port ASN package: $ref: "#/components/schemas/Package" settings: $ref: "#/components/schemas/PortSettings" physicalPortQuantity: type: integer description: Number of physical ports notifications: type: array description: Notification preferences items: $ref: "#/components/schemas/PortNotification" additionalInfo: type: array description: Port additional information items: $ref: "#/components/schemas/PortAdditionalInfo" endCustomer: $ref: "#/components/schemas/EndCustomer" physicalPorts: type: array description: Physical ports that implement this port items: $ref: "#/components/schemas/PhysicalPort" loas: type: array description: Port Loas items: $ref: "#/components/schemas/PortLoa" description: Port specification PhysicalPort: type: object properties: href: type: string description: Equinix assigned response attribute for an absolute URL that is the subject of the link's context. format: uri readOnly: true type: $ref: "#/components/schemas/PhysicalPortType" id: type: integer description: Equinix assigned response attribute for Physical Port Id deprecated: true state: $ref: "#/components/schemas/PortState" account: $ref: "#/components/schemas/SimplifiedAccount" interfaceSpeed: minimum: 0 type: integer description: Physical Port Speed in Mbps interfaceType: type: string description: Physical Port Interface Type uuid: type: string description: Equinix assigned response attribute for physical port identifier format: uuid tether: $ref: "#/components/schemas/PortTether" demarcationPoint: $ref: "#/components/schemas/PortDemarcationPoint" settings: $ref: "#/components/schemas/PhysicalPortSettings" interface: $ref: "#/components/schemas/PortInterface" notifications: type: array description: Notification preferences items: $ref: "#/components/schemas/PortNotification" additionalInfo: type: array description: Physical Port additional information items: $ref: "#/components/schemas/PortAdditionalInfo" order: $ref: "#/components/schemas/PortOrder" operation: $ref: "#/components/schemas/PortOperation" loas: type: array description: Port Loas items: $ref: "#/components/schemas/PortLoa" description: Physical Port specification PortRequest: required: - account - connectivitySourceType - encapsulation - location - physicalPortsSpeed - physicalPortsType - settings - type type: object description: PortRequest is the Request Object for creating single and bulk fabric ports allOf: - $ref: "#/components/schemas/Port" BulkPortRequest: type: object properties: data: type: array items: $ref: "#/components/schemas/PortRequest" description: Create bulk port request BulkPort: type: object properties: data: type: array description: Ports that are part of BulkPort items: $ref: "#/components/schemas/Port" description: Bulk Port specification BulkPhysicalPort: type: object properties: data: type: array description: add physical ports to virtual port items: $ref: "#/components/schemas/PhysicalPort" description: Add to Lag request AllPhysicalPortsResponse: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array description: GET All Physical Ports items: $ref: "#/components/schemas/PhysicalPort" description: GET All Physical Ports PortUpdateRequest: minItems: 1 type: array description: Port Update Request items: $ref: "#/components/schemas/PortChangeOperation" LinkProtocolGetResponse: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array items: $ref: "#/components/schemas/LinkProtocolResponse" description: List of Vlans PortV4SearchRequest: type: object properties: filter: $ref: "#/components/schemas/PortExpression" pagination: $ref: "#/components/schemas/PaginationRequest" sort: type: array items: $ref: "#/components/schemas/PortSortCriteria" description: Search requests containing criteria PortExpression: type: object properties: and: $ref: "#/components/schemas/PortExpressions" or: $ref: "#/components/schemas/PortExpressions" property: $ref: "#/components/schemas/PortSearchFieldName" operator: type: string enum: - = values: type: array items: type: string PortExpressions: type: array items: $ref: "#/components/schemas/PortExpression" PortSearchFieldName: type: string description: Possible field names to use on filters enum: - /project/projectId - /settings/productCode - /state PortSortCriteria: type: object properties: direction: $ref: "#/components/schemas/PortSortDirection" property: $ref: "#/components/schemas/PortSortBy" GetAllConnectionRouteAggregationsResponse: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array description: List of Route Aggregations attached to a Connection items: $ref: "#/components/schemas/ConnectionRouteAggregationData" RouteAggregationId: type: string description: Route Aggregations UUID example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d ConnectionRouteAggregationData: type: object properties: href: type: string description: Route Aggregation URI format: uri example: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d type: type: string description: Route Aggregation type enum: - BGP_IPv4_PREFIX_AGGREGATION uuid: type: string description: Route Aggregation identifier format: uuid example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d attachmentStatus: type: string enum: - ATTACHING - ATTACHED - DETACHED - DETACHING - FAILED - PENDING_BGP_CONFIGURATION GetAllConnectionRouteFiltersResponse: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array description: List of Route Filters attached to a Connection items: $ref: "#/components/schemas/ConnectionRouteFilterData" RouteFilterId: type: string description: Route Filters UUID example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d ConnectionRouteFilterData: type: object properties: href: type: string description: Route filter URI format: uri example: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d type: type: string description: Route filter type enum: - BGP_IPv4_PREFIX_FILTER - BGP_IPv6_PREFIX_FILTER uuid: type: string description: Route Filter identifier format: uuid example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d attachmentStatus: type: string enum: - ATTACHING - ATTACHED - DETACHED - DETACHING - FAILED - PENDING_BGP_CONFIGURATION direction: type: string enum: - INBOUND - OUTBOUND ConnectionRouteFiltersBase: required: - direction type: object properties: direction: type: string description: Route Filter direction to attach to a connection enum: - INBOUND - OUTBOUND RouteFiltersBase: required: - name - project - type type: object properties: type: type: string description: Route Filter type enum: - BGP_IPv4_PREFIX_FILTER - BGP_IPv6_PREFIX_FILTER name: type: string example: My-direct-route-1 description: type: string description: Customer-provided connection description project: $ref: "#/components/schemas/Project" RouteFiltersData: type: object properties: href: type: string description: Route filter URI format: uri example: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d type: type: string description: Route Filter type enum: - BGP_IPv4_PREFIX_FILTER - BGP_IPv6_PREFIX_FILTER uuid: type: string description: Route filter identifier format: uuid example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d name: type: string example: My-direct-route-1 description: type: string description: Customer-provided connection description state: $ref: "#/components/schemas/RouteFilterState" change: $ref: "#/components/schemas/RouteFiltersChange" notMatchedRuleAction: type: string enum: - ALLOW - DENY connectionsCount: type: integer example: 0 rulesCount: type: integer example: 0 project: $ref: "#/components/schemas/RouteFiltersData_project" changelog: $ref: "#/components/schemas/Changelog" RouteFiltersPatchRequest: minItems: 1 type: array description: Patch Route Filters request items: $ref: "#/components/schemas/RouteFiltersPatchRequestItem" RouteFilterChangeDataResponse: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array items: $ref: "#/components/schemas/RouteFilterChangeData" description: List of route filter changes ChangeId_1: type: string description: Route Filters Change UUID format: uuid example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 RouteFilterChangeData: type: object properties: status: type: string description: Current outcome of the change flow enum: - COMPLETED - FAILED - REQUESTED createdBy: type: string description: Created by user key createdDateTime: type: string description: Set when change flow starts format: date-time updatedBy: type: string description: Updated by user key updatedDateTime: type: string description: Set when change object is updated format: date-time information: type: string description: Additional information data: $ref: "#/components/schemas/RouteFiltersChangeOperation" description: Current state of latest route filter change allOf: - $ref: "#/components/schemas/RouteFiltersChange" GetRouteFilterGetConnectionsResponse: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array description: List of Connections using a Route Filter items: $ref: "#/components/schemas/RouteFilterConnectionsData" RouteFiltersSearchBase: type: object properties: filter: $ref: "#/components/schemas/RouteFiltersSearchBase_filter" pagination: $ref: "#/components/schemas/Pagination" sort: type: array items: $ref: "#/components/schemas/SortItem" RouteFiltersSearchFilterItem: type: object properties: property: type: string enum: - /type - /name - /project/projectId - /uuid - /state operator: type: string values: type: array items: type: string SortItem: type: object properties: property: type: string description: Possible field names to use on sorting default: /changeLog/updatedDateTime enum: - /type - /uuid - /name - /project/projectId - /state - /notMatchedRuleAction - /connectionsCount - /changeLog/createdDateTime - /changeLog/updatedDateTime direction: type: string description: Sorting direction default: DESC enum: - DESC - ASC RouteFiltersSearchResponse: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array description: List of route filters items: $ref: "#/components/schemas/RouteFiltersData" GetRouteFilterRulesResponse: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array description: List of Route Filter Rules items: $ref: "#/components/schemas/RouteFilterRulesData" RouteFilterRulesBase: required: - prefix type: object properties: name: type: string example: Private-subnet-filter description: type: string description: Customer-provided Route Filter Rule description prefix: type: string example: 192.168.0.0/24 prefixMatch: type: string example: orlonger, exact default: orlonger RouteFilterRulesData: type: object properties: href: type: string description: Route Filter Rules URI format: uri example: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/65b025ef-022b-4180-85cf-82cfc1ab655b type: type: string description: Route filter type enum: - BGP_IPv4_PREFIX_FILTER_RULE - BGP_IPv6_PREFIX_FILTER_RULE uuid: type: string description: Route Filter Rule identifier format: uuid example: 65b025ef-022b-4180-85cf-82cfc1ab655b name: type: string example: Private-subnet-filter-2 description: type: string description: Customer-provided Route Filter Rule description state: $ref: "#/components/schemas/RouteFilterRuleState" prefixMatch: type: string description: prefix matching operator example: exact default: orlonger change: $ref: "#/components/schemas/RouteFilterRulesChange" action: type: string enum: - PERMIT - DENY prefix: type: string example: 192.168.0.0/24 changelog: $ref: "#/components/schemas/Changelog" RouteFilterRuleId: type: string description: Route Filter Rule UUID example: 65b025ef-022b-4180-85cf-82cfc1ab655b RouteFilterRulesPatchRequest: minItems: 1 type: array description: Patch Route Filters Rule request items: $ref: "#/components/schemas/RouteFilterRulesPatchRequestItem" RouteFilterRulesChangeDataResponse: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array items: $ref: "#/components/schemas/RouteFilterRulesChangeData" description: List of route filter rule changes ChangeId_2: type: string description: Route Filter Rule Change UUID format: uuid example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 RouteFilterRulesChangeData: type: object properties: status: type: string description: Current outcome of the change flow enum: - COMPLETED - FAILED - REQUESTED createdBy: type: string description: Created by User Key createdDateTime: type: string description: Set when change flow starts format: date-time updatedBy: type: string description: Updated by User Key updatedDateTime: type: string description: Set when change object is updated format: date-time data: $ref: "#/components/schemas/RouteFilterRulesChangeOperation" description: Current state of latest route filter rules change allOf: - $ref: "#/components/schemas/RouteFilterRulesChange" RouteFilterRulesPostRequest: type: object properties: data: type: array description: Route Filter Rule configuration items: $ref: "#/components/schemas/RouteFilterRulesBase" description: Create Route Filter Rule POST request RouteAggregationsBase: required: - name - project - type type: object properties: type: type: string description: Route Aggregation type enum: - BGP_IPv4_PREFIX_AGGREGATION - BGP_IPv6_PREFIX_AGGREGATION name: type: string example: My-direct-route-1 description: type: string description: Customer-provided connection description project: $ref: "#/components/schemas/Project" RouteAggregationsData: type: object properties: href: type: string description: Route Aggregation URI format: uri example: https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d type: type: string description: Route Aggregation type enum: - BGP_IPv4_PREFIX_AGGREGATION - BGP_IPv6_PREFIX_AGGREGATION uuid: type: string description: Route Aggregation identifier format: uuid example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d name: type: string example: My-direct-route-1 description: type: string description: Customer-provided connection description state: $ref: "#/components/schemas/RouteAggregationState" change: $ref: "#/components/schemas/RouteAggregationsChange" connectionsCount: type: integer example: 0 rulesCount: type: integer example: 0 project: $ref: "#/components/schemas/RouteAggregationsData_project" changeLog: $ref: "#/components/schemas/Changelog" RouteAggregationsPatchRequest: minItems: 1 type: array description: Patch Route Aggregations request items: $ref: "#/components/schemas/RouteAggregationsPatchRequestItem" RouteAggregationChangeDataResponse: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array items: $ref: "#/components/schemas/RouteAggregationChangeData" description: List of Route Aggregation changes ChangeId_3: type: string description: Route Aggregations Change UUID format: uuid example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 RouteAggregationChangeData: type: object properties: status: type: string description: Current outcome of the change flow enum: - COMPLETED - FAILED - REQUESTED createdBy: type: string description: Created by User Key createdDateTime: type: string description: Set when change flow starts format: date-time updatedBy: type: string description: Updated by User Key updatedDateTime: type: string description: Set when change object is updated format: date-time information: type: string description: Additional information data: $ref: "#/components/schemas/RouteAggregationsChangeOperation" description: Current state of latest Route Aggregation change allOf: - $ref: "#/components/schemas/RouteAggregationsChange" GetRouteAggregationGetConnectionsResponse: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array description: List of Connections using a Route Aggregation items: $ref: "#/components/schemas/RouteAggregationConnectionsData" RouteAggregationsSearchBase: type: object properties: filter: $ref: "#/components/schemas/RouteAggregationsSearchBase_filter" pagination: $ref: "#/components/schemas/Pagination" sort: type: array items: $ref: "#/components/schemas/RouteAggregationSortItem" RouteAggregationsSearchFilterItem: type: object properties: property: type: string enum: - /type - /name - /project/projectId - /uuid - /state operator: type: string values: type: array items: type: string RouteAggregationSortItem: type: object properties: property: type: string description: Possible field names to use on sorting default: /changeLog/updatedDateTime enum: - /type - /uuid - /name - /project/projectId - /state - /connectionsCount - /changeLog/createdDateTime - /changeLog/updatedDateTime direction: type: string description: Sorting direction default: DESC enum: - DESC - ASC RouteAggregationsSearchResponse: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array description: List of Route Aggregations items: $ref: "#/components/schemas/RouteAggregationsData" GetRouteAggregationRulesResponse: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array description: List of Route Aggregation Rules items: $ref: "#/components/schemas/RouteAggregationRulesData" RouteAggregationRulesBase: required: - prefix type: object properties: name: type: string example: Private-subnet-Aggregation description: type: string description: Customer-provided Route Aggregation Rule description prefix: type: string example: 192.168.0.0/24 RouteAggregationRulesData: type: object properties: href: type: string description: Route Aggregation Rules URI format: uri example: https://api.equinix.com/fabric/v4/routeAggregations/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeAggregationRules/65b025ef-022b-4180-85cf-82cfc1ab655b type: type: string description: Route Aggregation type enum: - BGP_IPv4_PREFIX_AGGREGATION_RULE uuid: type: string description: Route Aggregation Rule identifier format: uuid example: 65b025ef-022b-4180-85cf-82cfc1ab655b name: type: string example: Private-subnet-aggregation-2 description: type: string description: Customer-provided Route Aggregation Rule description state: $ref: "#/components/schemas/RouteAggregationRuleState" change: $ref: "#/components/schemas/RouteAggregationRulesChange" prefix: type: string example: 192.168.0.0/24 changeLog: $ref: "#/components/schemas/Changelog" RouteAggregationRuleId: type: string description: Route Aggregation Rule UUID example: 65b025ef-022b-4180-85cf-82cfc1ab655b RouteAggregationRulesPatchRequest: minItems: 1 type: array description: Patch Route Aggregations Rule request items: $ref: "#/components/schemas/RouteAggregationRulesPatchRequestItem" RouteAggregationRulesChangeDataResponse: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array items: $ref: "#/components/schemas/RouteAggregationRulesChangeData" description: List of Route Aggregation Rule changes ChangeId_4: type: string description: Route Aggregation Rule Change UUID format: uuid example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 RouteAggregationRulesChangeData: type: object properties: status: type: string description: Current outcome of the change flow enum: - COMPLETED - FAILED - REQUESTED createdBy: type: string description: Created by User Key createdDateTime: type: string description: Set when change flow starts format: date-time updatedBy: type: string description: Updated by User Key updatedDateTime: type: string description: Set when change object is updated format: date-time data: $ref: "#/components/schemas/RouteAggregationRulesChangeOperation" description: Current state of latest Route Aggregation Rules change allOf: - $ref: "#/components/schemas/RouteAggregationRulesChange" RouteAggregationRulesPostRequest: type: object properties: data: type: array description: Route Aggregation Rule configuration items: $ref: "#/components/schemas/RouteAggregationRulesBase" description: Create Route Aggregation Rule POST request CloudRouterPostRequest: required: - location - name - notification - package - type type: object properties: type: type: string enum: - XF_ROUTER name: type: string description: Customer-provided Cloud Router name location: $ref: "#/components/schemas/SimplifiedLocationWithoutIBX" package: $ref: "#/components/schemas/CloudRouterPostRequestPackage" order: $ref: "#/components/schemas/Order" project: $ref: "#/components/schemas/Project" account: $ref: "#/components/schemas/SimplifiedAccount" notifications: type: array description: Preferences for notifications on connection configuration or status changes items: $ref: "#/components/schemas/SimplifiedNotification" marketplaceSubscription: $ref: "#/components/schemas/marketplaceSubscription" description: Create Cloud Router CloudRouter: type: object properties: href: type: string description: Cloud Routers URI format: uri readOnly: true example: https://api.equinix.com/fabric/v4/routers/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170 uuid: type: string description: Equinix-assigned access point identifier format: uuid example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 name: type: string description: Customer-provided Cloud Router name format: string example: test-fg-1 state: $ref: "#/components/schemas/CloudRouterAccessPointState" equinixAsn: type: integer description: Equinix ASN format: int64 example: 30000 connectionsCount: minimum: 0 type: integer description: Number of connections associated with this Access point marketplaceSubscription: $ref: "#/components/schemas/marketplaceSubscription" changeLog: $ref: "#/components/schemas/Changelog" change: $ref: "#/components/schemas/CloudRouterChange" description: Fabric Cloud Router object allOf: - $ref: "#/components/schemas/CloudRouterPostRequest" RouterId: type: string description: Cloud Router UUID format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 CloudRouterUpdateRequest: minItems: 1 type: array description: Fabric Cloud Router Update Request items: $ref: "#/components/schemas/CloudRouterChangeOperation" RouterId_1: type: string description: Router UUID format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 ActionState: $ref: "#/components/schemas/CloudRouterActionState" CloudRouterActionState: type: string description: Cloud router action state enum: - SUCCEEDED - FAILED - PENDING CloudRouterActionResponse: required: - changeLog - state - type - uuid type: object properties: type: $ref: "#/components/schemas/CloudRouterActionType" uuid: type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 description: type: string example: description state: $ref: "#/components/schemas/CloudRouterActionState" changeLog: $ref: "#/components/schemas/Changelog" href: type: string example: https://api.equinix.com//fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/actions/1e9414f1-763e-4c0a-86c6-0bc8336048d9 connection: $ref: "#/components/schemas/RouterActionsConnection" operation: $ref: "#/components/schemas/Operation" description: Cloud router actions response object CloudRouterActionRequest: required: - type type: object properties: type: $ref: "#/components/schemas/CloudRouterActionType" connection: $ref: "#/components/schemas/RouterActionsConnection" description: Cloud router action request CloudRouterActionsSearchRequest: type: object properties: filter: $ref: "#/components/schemas/CloudRouterActionsSearchFilters" pagination: $ref: "#/components/schemas/PaginationRequest" sort: type: array items: $ref: "#/components/schemas/CloudRouterActionsSearchSortCriteria" description: Search requests containing criteria CloudRouterActionsSearchFilters: type: object properties: and: maxItems: 8 type: array items: $ref: "#/components/schemas/CloudRouterActionsSearchFilter" CloudRouterActionsSearchFilter: type: object anyOf: - $ref: "#/components/schemas/CloudRouterActionsSearchExpression" - $ref: "#/components/schemas/CloudRouterActionsSearchOrFilter" CloudRouterActionsSearchExpression: type: object properties: property: type: string description: | Possible field names to use on filters: * `/type` - type of update * `/state` - action state * `/connection/uuid` - connection uuid associated * `/*` - all-category search example: /type operator: type: string description: | Possible operators to use on filters: * `=` - equal * `!=` - not equal * `>` - greater than * `>=` - greater than or equal to * `<` - less than * `<=` - less than or equal to * `[NOT] BETWEEN` - (not) between * `[NOT] LIKE` - (not) like * `[NOT] IN` - (not) in * `~*` - case-insensitive like example: = values: type: array items: type: string example: ROUTE_TABLE_ENTRY_UPDATE CloudRouterActionsSearchOrFilter: type: object properties: or: maxItems: 3 type: array items: $ref: "#/components/schemas/CloudRouterActionsSearchExpression" CloudRouterActionsSearchSortCriteria: type: object properties: direction: $ref: "#/components/schemas/CloudRouterActionsSearchSortDirection" property: $ref: "#/components/schemas/CloudRouterActionsSearchSortBy" CloudRouterActionsSearchSortDirection: type: string description: Sorting direction default: DESC enum: - DESC - ASC CloudRouterActionsSearchSortBy: type: string description: Possible field names to use on sorting default: /changeLog/updatedDateTime enum: - /changeLog/createdDateTime - /changeLog/updatedDateTime - /connection/name - /type CloudRouterActionsSearchResponse: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array description: Data returned from the API call. items: $ref: "#/components/schemas/CloudRouterActionResponse" ActionId_1: type: string description: Action UUID format: uuid example: 457400f8-d360-11e9-bb65-2a2ae2dbcced GetAllCloudRouterCommands: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array items: $ref: "#/components/schemas/CloudRouterCommand" description: List of Fabric Cloud Router Command CloudRouterCommandPostRequest: required: - project - request - type type: object properties: type: $ref: "#/components/schemas/CloudRouterCommandType" name: type: string description: Customer-provided Cloud Router Command name description: type: string description: Customer-provided Cloud Router Command description project: $ref: "#/components/schemas/Project" request: $ref: "#/components/schemas/CloudRouterCommandRequest" description: Execute Cloud Router Command Request CloudRouterCommand: type: object properties: href: type: string example: https://api.equinix.com//fabric/v4/routers/a1c6b7fd-aead-410a-96b4-b1dfa1071700/commands/1e9414f1-763e-4c0a-86c6-0bc8336048d9 type: $ref: "#/components/schemas/CloudRouterCommandType" uuid: type: string format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 name: type: string description: Customer-provided Cloud Router name format: string example: test-fg-1 description: type: string example: description state: $ref: "#/components/schemas/CloudRouterCommandState" project: $ref: "#/components/schemas/Project" request: $ref: "#/components/schemas/CloudRouterCommandRequest" response: $ref: "#/components/schemas/CloudRouterCommandResponse" changeLog: $ref: "#/components/schemas/Changelog" description: Get Fabric Cloud Router Command response object CloudRouterCommandSearchRequest: type: object properties: filter: $ref: "#/components/schemas/CloudRouterCommandSearchFilters" pagination: $ref: "#/components/schemas/PaginationRequest" sort: type: array items: $ref: "#/components/schemas/CloudRouterCommandSearchSortCriteria" description: Search requests containing criteria CloudRouterCommandSearchFilters: type: object properties: and: maxItems: 8 type: array items: $ref: "#/components/schemas/CloudRouterCommandSearchFilter" CloudRouterCommandSearchFilter: type: object anyOf: - $ref: "#/components/schemas/CloudRouterCommandSearchExpression" - $ref: "#/components/schemas/CloudRouterCommandSearchOrFilter" CloudRouterCommandSearchExpression: type: object properties: property: type: string description: | Possible field names to use on filters: * `/type` - type of command * `/name` - name of command * `/state` - state of command * `/request/destination` - destination of command request * `/request/sourceConnection/uuid` - source connection uuid * `/*` - all-category search example: /state operator: type: string description: | Possible operators to use on filters: * `=` - equal * `!=` - not equal * `>` - greater than * `>=` - greater than or equal to * `<` - less than * `<=` - less than or equal to * `[NOT] BETWEEN` - (not) between * `[NOT] LIKE` - (not) like * `[NOT] IN` - (not) in * `~*` - case-insensitive like example: = values: type: array items: type: string example: PING_COMMAND CloudRouterCommandSearchOrFilter: type: object properties: or: maxItems: 3 type: array items: $ref: "#/components/schemas/CloudRouterCommandSearchExpression" CloudRouterCommandSearchSortCriteria: type: object properties: direction: $ref: "#/components/schemas/CloudRouterCommandSearchSortDirection" property: $ref: "#/components/schemas/CloudRouterCommandSearchSortBy" CloudRouterCommandSearchSortDirection: type: string description: Sorting direction default: DESC enum: - DESC - ASC CloudRouterCommandSearchSortBy: type: string description: Possible field names to use on sorting default: /changeLog/updatedDateTime enum: - /changeLog/createdDateTime - /changeLog/updatedDateTime - /name - /type CloudRouterCommandSearchResponse: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array description: Data returned from the API call. items: $ref: "#/components/schemas/CloudRouterCommand" CommandId: type: string description: Command UUID format: uuid example: 37c10edc-ba2e-4240-a850-8a48f9c47d00 RouteTableEntrySearchRequest: type: object properties: filter: $ref: "#/components/schemas/RouteTableEntryFilters" pagination: $ref: "#/components/schemas/PaginationRequest" sort: type: array items: $ref: "#/components/schemas/RouteTableEntrySortCriteria" description: Search requests containing criteria RouteTableEntryFilters: type: object properties: and: maxItems: 8 type: array items: $ref: "#/components/schemas/RouteTableEntryFilter" RouteTableEntryFilter: type: object anyOf: - $ref: "#/components/schemas/RouteTableEntrySimpleExpression" - $ref: "#/components/schemas/RouteTableEntryOrFilter" RouteTableEntrySimpleExpression: type: object properties: property: type: string description: | Possible field names to use on filters: * `/type` - Route table entry type * `/prefix` - Route table entry prefix * `/nextHop` - Route table entry nextHop * `/state` - Route table entry state * `/*` - all-category search example: /type operator: type: string description: | Possible operators to use on filters: * `=` - equal * `!=` - not equal * `>` - greater than * `>=` - greater than or equal to * `<` - less than * `<=` - less than or equal to * `[NOT] BETWEEN` - (not) between * `[NOT] LIKE` - (not) like * `[NOT] IN` - (not) in * `~*` - case-insensitive like example: = values: type: array items: type: string example: IPv4_BGP_ROUTE RouteTableEntryOrFilter: type: object properties: or: maxItems: 3 type: array items: $ref: "#/components/schemas/RouteTableEntrySimpleExpression" RouteTableEntrySortCriteria: type: object properties: direction: $ref: "#/components/schemas/RouteTableEntrySortDirection" property: $ref: "#/components/schemas/RouteTableEntrySortBy" RouteTableEntrySortDirection: type: string description: Sorting direction default: DESC enum: - DESC - ASC RouteTableEntrySortBy: type: string description: Possible field names to use on sorting default: /changeLog/updatedDateTime enum: - /changeLog/createdDateTime - /changeLog/updatedDateTime - /prefix - /nextHop - /connection/name - /type RouteTableEntrySearchResponse: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array description: Data returned from the API call. items: $ref: "#/components/schemas/RouteTableEntry" ValidateRequest: type: object properties: filter: $ref: "#/components/schemas/ValidateRequest_filter" description: Validate connection auth api key or vlan ValidateSubnetResponse: type: object properties: additionalInfo: type: array description: Additional information items: $ref: "#/components/schemas/ConnectionSideAdditionalInfo" description: ValidateResponse CloudRouterSearchRequest: type: object properties: filter: $ref: "#/components/schemas/CloudRouterFilters" pagination: $ref: "#/components/schemas/PaginationRequest" sort: type: array items: $ref: "#/components/schemas/CloudRouterSortCriteria" description: Search requests containing criteria CloudRouterFilters: type: object properties: and: maxItems: 8 type: array items: $ref: "#/components/schemas/CloudRouterFilter" CloudRouterFilter: type: object anyOf: - $ref: "#/components/schemas/CloudRouterSimpleExpression" - $ref: "#/components/schemas/CloudRouterOrFilter" CloudRouterSimpleExpression: type: object properties: property: type: string description: | Possible field names to use on filters: * `/project/projectId` - project id (mandatory) * `/name` - Fabric Cloud Router name * `/uuid` - Fabric Cloud Router uuid * `/state` - Fabric Cloud Router status * `/location/metroCode` - Fabric Cloud Router metro code * `/location/metroName` - Fabric Cloud Router metro name * `/package/code` - Fabric Cloud Router package * `/*` - all-category search example: /name operator: type: string description: | Possible operators to use on filters: * `=` - equal * `!=` - not equal * `>` - greater than * `>=` - greater than or equal to * `<` - less than * `<=` - less than or equal to * `[NOT] BETWEEN` - (not) between * `[NOT] LIKE` - (not) like * `[NOT] IN` - (not) in * `ILIKE` - case-insensitive like example: = values: type: array items: type: string example: FabricCloudRouter-1 CloudRouterOrFilter: type: object properties: or: maxItems: 3 type: array items: $ref: "#/components/schemas/CloudRouterSimpleExpression" CloudRouterSortCriteria: type: object properties: direction: $ref: "#/components/schemas/CloudRouterSortDirection" property: $ref: "#/components/schemas/CloudRouterSortBy" CloudRouterSortDirection: type: string description: Sorting direction default: DESC enum: - DESC - ASC CloudRouterSortBy: type: string description: Possible field names to use on sorting default: /changeLog/updatedDateTime enum: - /name - /uuid - /state - /location/metroCode - /location/metroName - /package/code - /changeLog/createdDateTime - /changeLog/updatedDateTime SearchResponse: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array description: Data returned from the API call. items: $ref: "#/components/schemas/CloudRouter" PackageResponse: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array description: Data returned from the API call. items: $ref: "#/components/schemas/CloudRouterPackage" RouterPackageCode: type: string description: Router package code enum: - LAB - ADVANCED - STANDARD - PREMIUM CloudRouterPackage: type: object properties: href: type: string description: Cloud Router package URI format: uri readOnly: true example: https://api.equinix.com/fabric/v4/routerPackages/LAB type: type: string description: Type of Router package example: ROUTER_PACKAGE enum: - ROUTER_PACKAGE code: $ref: "#/components/schemas/code" description: type: string description: Fabric Cloud Router Package description totalIPv4RoutesMax: minimum: 0 type: integer description: Cloud Router package BGP IPv4 routes limit example: 50 totalIPv6RoutesMax: minimum: 0 type: integer description: Cloud Router package BGP IPv6 routes limit example: 50 routeFilterSupported: type: boolean description: CloudRouter package route filter support vcCountMax: minimum: 0 type: integer description: CloudRouter package Max Connection limit example: 10 crCountMax: minimum: 0 type: integer description: CloudRouter package Max CloudRouter limit example: 3 vcBandwidthMax: minimum: 0 type: integer description: CloudRouter package Max Bandwidth limit example: 50 changeLog: $ref: "#/components/schemas/PackageChangeLog" description: Fabric Cloud Router Package HealthResponse: type: object properties: href: type: string description: The Canonical URL at which the resource resides. version: type: string description: Indicator of a version release: type: string description: release details. state: type: string description: status of a service apiServices: $ref: "#/components/schemas/ApiServices" description: GET Services Health ConnectionResponse: type: object properties: additionalInfo: type: array description: Additional information items: $ref: "#/components/schemas/ConnectionSideAdditionalInfo" data: type: array description: Connection response data items: $ref: "#/components/schemas/ValidateConnectionResponse" description: ValidateResponse Pagination: required: - limit - total type: object properties: offset: minimum: 0 type: integer description: Index of the first item returned in the response. The default is 0. default: 0 limit: minimum: 0 type: integer description: Maximum number of search results returned per page. Number must be between 1 and 100, and the default is 20. default: 20 total: minimum: 0 type: integer description: Total number of elements returned. next: type: string description: URL relative to the next item in the response. previous: type: string description: URL relative to the previous item in the response. description: Pagination response information NetworkPostRequest: required: - name - notifications - scope - type type: object properties: type: $ref: "#/components/schemas/NetworkType" name: type: string description: Customer-provided network name scope: $ref: "#/components/schemas/NetworkScope" location: $ref: "#/components/schemas/SimplifiedLocation" project: $ref: "#/components/schemas/Project" notifications: type: array description: Preferences for notifications on network configuration or status changes items: $ref: "#/components/schemas/SimplifiedNotification" description: Create Network Network: type: object description: Network specification allOf: - required: - changeLog - href - state - uuid type: object properties: href: type: string description: Network URI format: uri readOnly: true example: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784 uuid: type: string description: Equinix-assigned network identifier format: uuid example: 92dc376a-a932-43aa-a6a2-c806dedbd784 state: $ref: "#/components/schemas/NetworkState" connectionsCount: type: number description: number of connections created on the network account: $ref: "#/components/schemas/SimplifiedAccount" change: $ref: "#/components/schemas/SimplifiedNetworkChange" operation: $ref: "#/components/schemas/NetworkOperation" changeLog: $ref: "#/components/schemas/Changelog" links: type: array description: Network sub-resources links readOnly: true items: $ref: "#/components/schemas/Link" - $ref: "#/components/schemas/NetworkPostRequest" NetworkId: type: string description: Network UUID format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 NetworkUpdateRequest: minItems: 1 type: array description: Fabric Network Update Request items: $ref: "#/components/schemas/NetworkChangeOperation" NetworkSearchRequest: type: object properties: filter: $ref: "#/components/schemas/NetworkFilter" pagination: $ref: "#/components/schemas/PaginationRequest" sort: type: array items: $ref: "#/components/schemas/NetworkSortCriteria" description: Search requests containing criteria NetworkFilter: type: object properties: and: $ref: "#/components/schemas/NetworkSimpleExpression" or: $ref: "#/components/schemas/NetworkSimpleExpression" property: $ref: "#/components/schemas/NetworkSearchFieldName" operator: type: string example: = enum: - = - "!=" - ">" - ">=" - < - <= - BETWEEN - NOT BETWEEN - LIKE - NOT LIKE - ILIKE - NOT ILIKE - IN - NOT IN values: type: array items: type: string example: Network-1 NetworkSimpleExpression: type: array items: $ref: "#/components/schemas/NetworkFilter" NetworkSearchFieldName: type: string description: Possible field names to use on filters example: /name enum: - /name - /uuid - /scope - /type - /operation/equinixStatus - /location/region - /project/projectId - /account/globalCustId - /account/orgId - /deletedDate - /* NetworkSortCriteria: type: object properties: direction: $ref: "#/components/schemas/NetworkSortDirection" property: $ref: "#/components/schemas/NetworkSortBy" NetworkSortDirection: type: string description: Sorting direction default: DESC enum: - DESC - ASC NetworkSortBy: type: string description: Possible field names to use on sorting default: /changeLog/updatedDateTime enum: - /name - /uuid - /scope - /operation/equinixStatus - /location/region - /changeLog/createdDateTime - /changeLog/updatedDateTime NetworkSearchResponse: type: object properties: pagination: $ref: "#/components/schemas/Pagination" sort: type: array items: $ref: "#/components/schemas/NetworkSortCriteriaResponse" data: type: array items: $ref: "#/components/schemas/Network" description: List of networks NetworkConnections: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array items: $ref: "#/components/schemas/Connection" description: List of network changes NetworkChangeResponse: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array items: $ref: "#/components/schemas/NetworkChange" description: List of network changes ChangeId_5: type: string description: Network Change UUID format: uuid example: 6d500177-9404-41f2-99e8-2bf1a84d8db5 NetworkChange: type: object properties: href: type: string description: Network URI format: uri readOnly: true example: https://api.equinix.com/fabric/v4/networks/2a4fb415-5a7f-436f-bae6-02f5e403deec/changes/4b17da68-3d6b-436d-9c8f-2105f3b950d9 uuid: type: string description: Uniquely identifies a change format: uuid example: 4b17da68-3d6b-436d-9c8f-2105f3b950d9 type: $ref: "#/components/schemas/NetworkChangeType" status: $ref: "#/components/schemas/NetworkChangeStatus" createdDateTime: type: string description: Set when change flow starts format: date-time example: 2020-11-06T07:00:00Z updatedDateTime: type: string description: Set when change object is updated format: date-time example: 2020-11-06T07:00:00Z data: type: array items: $ref: "#/components/schemas/NetworkChangeOperation" description: Current state of latest network change precisionTimeServiceRequest: title: precisionTimeServiceRequest required: - connections - ipv4 - name - package - type type: object properties: type: type: string description: Precision Time Service Type refers to the corresponding Protocol. enum: - NTP - PTP name: type: string description: Precision Time Service name. package: $ref: "#/components/schemas/precisionTimePackageRequest" connections: type: array items: $ref: "#/components/schemas/virtualConnectionUuid" ipv4: $ref: "#/components/schemas/ipv4" ntpAdvancedConfiguration: $ref: "#/components/schemas/ntpAdvanceConfiguration" ptpAdvancedConfiguration: $ref: "#/components/schemas/ptpAdvanceConfiguration" project: $ref: "#/components/schemas/Project" order: $ref: "#/components/schemas/precisionTimeOrder" description: Create Precision Time Service Request Schema. precisionTimeServiceResponse: title: precisionTimeServiceResponse required: - href - package - state - type - uuid type: object properties: href: type: string description: Precision Time Service URI. format: uri type: type: string description: Precision Time Service type refers to the corresponding protocol. enum: - NTP - PTP name: type: string description: Precision Time Service Name. uuid: type: string description: Precision Time Service UUID. format: uuid state: type: string description: Precision Time Service Status. enum: - CANCELLED - CANCELLING - CONFIGURING - CONFIGURING_FAILED - DRAFT - DEPROVISIONING - DEPROVISIONING_FAILED - DEPROVISIONED - PROVISIONED - PROVISIONING - PROVISIONING_FAILED - REPROVISIONING - REPROVISIONING_FAILED package: $ref: "#/components/schemas/precisionTimePackagePostResponse" connections: maxItems: 2 minItems: 1 uniqueItems: true type: array description: Fabric Connections associated with Precision Time Service. items: $ref: "#/components/schemas/virtualConnectionTimeServiceResponse" ipv4: $ref: "#/components/schemas/ipv4" ntpAdvancedConfiguration: $ref: "#/components/schemas/ntpAdvanceConfiguration" ptpAdvancedConfiguration: $ref: "#/components/schemas/ptpAdvanceConfiguration" project: $ref: "#/components/schemas/Project" account: $ref: "#/components/schemas/SimplifiedAccount" order: $ref: "#/components/schemas/precisionTimeOrder" pricing: $ref: "#/components/schemas/precisionTimePrice" changeLog: $ref: "#/components/schemas/Changelog" description: Precision Time Service Response Schema. ServiceId: type: string description: Precision Time Service UUID format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 precisionTimeChangeOperation: required: - op - path - value type: object properties: op: type: string description: Handy shortcut for operation name enum: - replace - add - remove path: type: string description: path inside document leading to updated parameter enum: - /name - /package/code - /ipv4 - /ntpAdvancedConfiguration - /ptpAdvancedConfiguration value: type: object description: new value for updated parameter description: Fabric Precision Timing change operation data TimeServicesSearchRequest: type: object properties: filter: $ref: "#/components/schemas/TimeServiceFilters" pagination: $ref: "#/components/schemas/PaginationRequest" sort: type: array items: $ref: "#/components/schemas/TimeServiceSortCriteria" description: Search requests containing criteria TimeServiceFilters: type: object properties: and: maxItems: 8 type: array items: $ref: "#/components/schemas/TimeServiceFilter" TimeServiceFilter: type: object anyOf: - $ref: "#/components/schemas/TimeServiceSimpleExpression" - $ref: "#/components/schemas/TimeServiceOrFilter" TimeServiceSimpleExpression: type: object properties: property: type: string description: | Possible field names to use on filters: * `/project/projectId` - project id (mandatory) * `/name` - Precision Time Service name * `/uuid` - Precision Time Service uuid * `/type` - Precision Time Service protocol * `/state` - Precision Time Service status * `/account/accountNumber` - Precision Time Service account number * `/package/code` - Precision Time Service package * `/*` - all-category search example: /name operator: type: string description: | Possible operators to use on filters: * `=` - equal * `!=` - not equal * `[NOT] BETWEEN` - (not) between * `[NOT] LIKE` - (not) like * `[NOT] IN` - (not) in * `ILIKE` - case-insensitive like example: = values: type: array items: type: string example: FabricPrecisionTimeService-1 TimeServiceOrFilter: type: object properties: or: maxItems: 3 type: array items: $ref: "#/components/schemas/TimeServiceSimpleExpression" TimeServiceSortCriteria: type: object properties: direction: $ref: "#/components/schemas/TimeServiceSortDirection" property: $ref: "#/components/schemas/TimeServiceSortBy" TimeServiceSortDirection: type: string description: Sorting direction default: DESC enum: - DESC - ASC TimeServiceSortBy: type: string description: Possible field names to use on sorting default: /changeLog/updatedDateTime enum: - /name - /uuid - /state - /type - /package/code - /changeLog/createdDateTime - /changeLog/updatedDateTime ServiceSearchResponse: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array description: Data returned from the API call. items: $ref: "#/components/schemas/precisionTimeServiceResponse" precisionTimeServiceConnectionsResponse: title: precisionTimeServiceConnectionResponse type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array description: Data returned from the API call items: $ref: "#/components/schemas/connectionLink" description: EPT service instance's L2 connections precisionTimeServicePackagesResponse: title: precisionTimeServicePackagesResponse type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array description: Data returned from the API call items: $ref: "#/components/schemas/precisionTimePackageResponse" description: Precision Packages precisionTimePackageResponse: title: precisionTimePackageRespose required: - bandwidth - code - type type: object properties: href: type: string format: uri type: type: string enum: - TIME_SERVICE_PACKAGE code: type: string enum: - NTP_STANDARD - NTP_ENTERPRISE - PTP_STANDARD - PTP_ENTERPRISE bandwidth: type: integer description: Connection bandwidth in Mbps. example: 10 clientsPerSecondMax: minimum: 0 type: integer description: Max. number of clients that can be synchronized per second at a packet rate of 1 per second. example: 100 redundancySupported: type: boolean description: Is Redundant virtual connection supported for the package code. example: false multiSubnetSupported: type: boolean description: Is Multiple subnet supported for the package code. example: true accuracySlaUnit: type: string description: Accuracy SLA unit. example: microseconds accuracySla: type: integer description: Accuracy SLA for the package code, -1 value denotes the accuracySla is not published. example: 50 accuracySlaMin: minimum: 1 type: integer description: Typical minimum Accuracy for the package code. example: 1 accuracySlaMax: minimum: 1 type: integer description: Typical maximum Accuracy for the package code. example: 10 changelog: $ref: "#/components/schemas/Changelog" description: EPT Service Package Information example: href: https://api.equinix.com/fabric/v4/timeServicePackage/NTP_STANDARD type: TIME_SERVICE_PACKAGE code: NTP_STANDARD bandwidth: 10 accuracySlaUnit: microseconds accuracySla: 50 accuracySlaMin: 1 accuracySlaMax: 10 clientsPerSecondMax: 100 redundancySupported: true multiSubnetSupported: true changeLog: createdDateTime: 2023-05-16T07:50:49.749Z updatedDateTime: 2023-05-17T07:50:49.749Z SubscriptionId: type: string description: Subscription Id format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 SubscriptionResponse: required: - entitlements - marketplace - state type: object properties: href: type: string description: Subscription URL format: uri uuid: type: string description: Unique identifier of the Subscription format: uuid state: $ref: "#/components/schemas/SubscriptionState" marketplace: type: string description: Marketplace Type enum: - AWS - GCP - AZURE - REDHAT offerType: type: string description: Marketplace Offer Type enum: - PUBLIC - PRIVATE_OFFER isAutoRenew: type: boolean description: Is Auto Renewal Enabled example: true offerId: type: string description: Marketplace Offer Id trial: $ref: "#/components/schemas/SubscriptionTrial" metroCodes: type: array description: List of available metro items: type: string entitlements: type: array description: List of entitlements associated with the subscription items: $ref: "#/components/schemas/SubscriptionEntitlementResponse" changelog: $ref: "#/components/schemas/Changelog" description: Subscription Response SubscriptionState: type: string description: Subscription State enum: - ACTIVE - EXPIRED - CANCELLED - GRACE_PERIOD SubscriptionTrial: type: object properties: enabled: type: boolean description: Free Trial Enabled expiryDateTime: type: string description: Free Trial Expiry Date format: date-time description: Free Trial Subscription SubscriptionEntitlementResponse: type: object properties: uuid: type: string description: Subscription Entitlement Id format: uuid quantityEntitled: minimum: 0 type: integer description: Quantity entitled for the subscription quantityConsumed: minimum: 0 type: integer description: Quantity consumed from the entitlement quantityAvailable: minimum: 0 type: integer description: Quantity available from the entitlement asset: $ref: "#/components/schemas/SubscriptionAsset" description: Subscription entitlement SubscriptionAsset: type: object properties: type: type: string description: Type of the subscription asset ( XF_ROUTER ,IP_VC, IPWAN_VC ) package: $ref: "#/components/schemas/SubscriptionRouterPackageType" bandwidth: type: integer description: Bandwidth of the asset in Mbps description: Asset information SubscriptionRouterPackageType: type: object properties: code: type: string description: Cloud Router package code enum: - ADVANCED - STANDARD description: Cloud Router Package Type GetAllStreamResponse: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array description: Data returned from the API call. items: $ref: "#/components/schemas/Stream" StreamPostRequest: type: object properties: type: type: string enum: - TELEMETRY_STREAM name: type: string description: Customer-provided stream name description: type: string description: Customer-provided stream description project: $ref: "#/components/schemas/Project" description: Create Stream Stream: type: object properties: href: type: string description: Stream URI format: uri readOnly: true example: https://api.equinix.com/fabric/v4/streams/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170 uuid: type: string description: Equinix-assigned access point identifier format: uuid example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 state: type: string description: Stream provision state enum: - PROVISIONING - PROVISIONED - REPROVISIONING - DEPROVISIONING - DEPROVISIONED - FAILED assetsCount: type: integer description: Stream assets count example: 1 streamSubscriptionsCount: type: integer description: Stream subscriptions count example: 2 changeLog: $ref: "#/components/schemas/Changelog" description: Stream object allOf: - $ref: "#/components/schemas/StreamPostRequest" StreamId: type: string description: Stream UUID format: uuid example: 657400f8-d360-11e9-bb65-2a2ae2dbcce5 StreamPutRequest: type: object properties: name: type: string description: Customer-provided stream name description: type: string description: Customer-provided stream description description: Update Stream StreamAssetSearchRequest: type: object properties: filter: $ref: "#/components/schemas/StreamAssetFilters" pagination: $ref: "#/components/schemas/PaginationRequest" sort: type: array items: $ref: "#/components/schemas/StreamAssetSortCriteria" description: Search requests containing criteria StreamAssetFilters: type: object properties: and: maxItems: 8 type: array items: $ref: "#/components/schemas/StreamAssetFilter" StreamAssetFilter: type: object anyOf: - $ref: "#/components/schemas/StreamAssetSimpleExpression" - $ref: "#/components/schemas/StreamAssetOrFilter" StreamAssetSimpleExpression: type: object properties: property: type: string description: | Possible field names to use on filters: * `/uuid` - Asset uuid * `/streamUuid` - Stream uuid * `/projectId` - Asset projectId * `/*` - all-category search example: /name operator: type: string description: | Possible operators to use on filters: * `=` - equal * `!=` - not equal * `>` - greater than * `>=` - greater than or equal to * `<` - less than * `<=` - less than or equal to * `[NOT] BETWEEN` - (not) between * `[NOT] LIKE` - (not) like * `[NOT] IN` - (not) in * `ILIKE` - case-insensitive like example: = values: type: array items: type: string example: FabricStreamAsset-1 StreamAssetOrFilter: type: object properties: or: maxItems: 3 type: array items: $ref: "#/components/schemas/StreamAssetSimpleExpression" StreamAssetSortCriteria: type: object properties: direction: $ref: "#/components/schemas/StreamAssetSortDirection" property: $ref: "#/components/schemas/StreamAssetSortBy" StreamAssetSortDirection: type: string description: Sorting direction default: DESC enum: - DESC - ASC StreamAssetSortBy: type: string description: Possible field names to use on sorting default: /uuid enum: - /uuid GetAllStreamAssetResponse: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array description: Data returned from the API call. items: $ref: "#/components/schemas/StreamAsset" AssetId_1: type: string description: Stream Asset UUID format: uuid example: 757400f8-d360-11e9-bb65-2a2ae2dbcce6 Asset: type: string enum: - ports - connections - routers - metros - organizations - projects StreamAsset: type: object properties: href: type: string description: Stream Asset URI format: uri readOnly: true uuid: type: string description: Equinix-assigned access point identifier format: uuid example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 type: type: string description: Asset types enum: - XF_PORT - IP_VC - EVPLAN_VC - EVPL_VC - XF_METRO - XF_ROUTER - ORGANIZATION - PROJECT metricsEnabled: type: boolean description: enable metric example: false attachmentStatus: type: string description: asset status enum: - ATTACHING - ATTACHED - DETACHED - DETACHING - FAILED description: Stream object StreamAssetPutRequest: type: object properties: metricsEnabled: type: boolean description: enable metric example: false description: Update Stream Asset GetAllStreamSubscriptionResponse: type: object properties: pagination: $ref: "#/components/schemas/Pagination" data: type: array description: Data returned from the API call. items: $ref: "#/components/schemas/StreamSubscription" StreamSubscriptionPostRequest: type: object properties: type: type: string enum: - STREAM_SUBSCRIPTION name: type: string description: Customer-provided stream subscription name description: type: string description: Customer-provided stream subscription description enabled: type: boolean description: Stream subscription enabled status example: true metricSelector: $ref: "#/components/schemas/StreamSubscriptionSelector" eventSelector: $ref: "#/components/schemas/StreamSubscriptionSelector" sink: $ref: "#/components/schemas/StreamSubscriptionSink" description: Create Stream Subscription StreamSubscriptionSelector: type: object properties: include: maxItems: 8 type: array items: $ref: "#/components/schemas/StreamSubscriptionSelectorExpression" except: maxItems: 8 type: array items: $ref: "#/components/schemas/StreamSubscriptionSelectorExpression" StreamSubscriptionSelectorExpression: type: string description: | Supported event or metric types to use on event and metric selectors: * `*` - all events or metrics * `equinix.fabric.port.*` - port events or metrics * `equinix.fabric.connection.*` - connection events or metrics * `equinix.fabric.router.*` - cloud router events * `equinix.fabric.metro.*` - metro metrics * `equinix.fabric.network.*` - network events * `equinix.fabric.service_token.*` - service token events * `equinix.network_edge.*` - network edge events * `equinix.network_edge.acl.*` - network edge acl events * `equinix.network_edge.device.*` - network edge device events * `equinix.access_manager.*` - identity access manager events * `equinix.access_manager.user.role.*` - identity access manager user role events example: equinix.fabric.connection.* StreamSubscriptionSink: type: object properties: uri: type: string description: any publicly reachable http endpoint type: type: string description: destination type enum: - DATADOG - PAGERDUTY - SPLUNK_HEC - SLACK - TEAMS - CUSTOM batchEnabled: type: boolean description: batch mode on/off example: false batchSizeMax: type: integer description: maximum batch size batchWaitTimeMax: type: integer description: maximum batch waiting time credential: $ref: "#/components/schemas/StreamSubscriptionSinkCredential" settings: $ref: "#/components/schemas/StreamSubscriptionSinkSetting" host: type: string description: sink host description: Create Stream destination StreamSubscriptionSinkCredential: type: object properties: type: type: string description: credential type enum: - ACCESS_TOKEN - INTEGRATION_KEY - API_KEY - USERNAME_PASSWORD accessToken: type: string description: passed as Authorization header value integrationKey: type: string description: passed as Authorization header value apiKey: type: string description: passed as Authorization header value username: type: string description: passed as Authorization header value password: type: string description: passed as Authorization header value description: Stream subscription sink credentials StreamSubscriptionSinkSetting: type: object properties: eventIndex: type: string description: event index metricIndex: type: string description: metric index source: type: string description: source applicationKey: type: string description: Application key eventUri: type: string description: event uri metricUri: type: string description: metric uri description: Stream subscription sink settings StreamSubscription: type: object properties: href: type: string description: Stream Subscription URI format: uri readOnly: true example: https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/subscriptions/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170 uuid: type: string description: Equinix-assigned access point identifier format: uuid example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 type: type: string description: type enum: - STREAM_SUBSCRIPTION name: type: string description: Customer-provided subscription name description: type: string description: Customer-provided subscription description state: type: string description: Steam subscription provision state enum: - PROVISIONING - PROVISIONED - REPROVISIONING - DEPROVISIONING - DEPROVISIONED - FAILED enabled: type: boolean description: Stream subscription enabled status metricSelector: $ref: "#/components/schemas/StreamSubscriptionSelector" eventSelector: $ref: "#/components/schemas/StreamSubscriptionSelector" sink: $ref: "#/components/schemas/StreamSubscriptionSink" changeLog: $ref: "#/components/schemas/Changelog" lastErrorMessage: type: string description: HTTP response from sink type if error occurred description: Stream Subscription object StreamSubscriptionId: type: string description: Stream Subscription UUID format: uuid example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 StreamSubscriptionPutRequest: type: object properties: name: type: string description: Customer-provided stream subscription name description: type: string description: Customer-provided stream subscription description enabled: type: boolean description: Stream subscription enabled status example: true filters: $ref: "#/components/schemas/StreamSubscriptionFilter" metricSelector: $ref: "#/components/schemas/StreamSubscriptionSelector" eventSelector: $ref: "#/components/schemas/StreamSubscriptionSelector" sink: $ref: "#/components/schemas/StreamSubscriptionSink" description: Update Stream Subscription StreamAlertRule: type: object properties: href: type: string description: Stream Alert Rule URI format: uri readOnly: true uuid: type: string description: Equinix-assigned access point identifier format: uuid example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 type: type: string description: Stream subscription type enum: - METRIC_ALERT name: type: string description: Customer-provided stream alert rule name description: type: string description: Customer-provided stream alert rule description state: type: string description: Steam subscription provision state enum: - ACTIVE - INACTIVE enabled: type: boolean description: Stream alert rule enabled status default: true metricName: type: string description: Stream alert rule metric name enum: - equinix.fabric.connection.bandwidth_tx.usage - equinix.fabric.connection.bandwidth_rx.usage - equinix.fabric.port.bandwidth_tx.usage - equinix.fabric.port.bandwidth_rx.usage - equinix.fabric.port.packets_erred_tx.count - equinix.fabric.port.packets_erred_rx.count - equinix.fabric.port.packets_dropped_tx.count - equinix.fabric.port.packets_dropped_rx.count - equinix.fabric.metro._.latency resourceSelector: $ref: "#/components/schemas/ResourceSelector" windowSize: type: string description: Stream alert rule metric window size example: PT15M operand: type: string description: Stream alert rule metric operand enum: - ABOVE - BELOW warningThreshold: type: string description: Stream alert rule metric warning threshold criticalThreshold: type: string description: Stream alert rule metric critical threshold changeLog: $ref: "#/components/schemas/Changelog" description: Stream object AlertRulePostRequest: type: object properties: type: type: string enum: - METRIC_ALERT name: type: string description: Customer-provided stream name description: type: string description: Customer-provided stream description enabled: type: boolean description: Stream alert rule enabled status default: true metricName: type: string description: Stream alert rule metric name enum: - equinix.fabric.connection.bandwidth_tx.usage - equinix.fabric.connection.bandwidth_rx.usage - equinix.fabric.port.bandwidth_tx.usage - equinix.fabric.port.bandwidth_rx.usage - equinix.fabric.port.packets_erred_tx.count - equinix.fabric.port.packets_erred_rx.count - equinix.fabric.port.packets_dropped_tx.count - equinix.fabric.port.packets_dropped_rx.count - equinix.fabric.metro._.latency resourceSelector: $ref: "#/components/schemas/ResourceSelector" windowSize: type: string description: Stream alert rule metric window size example: PT15M operand: type: string description: Stream alert rule metric operand enum: - ABOVE - BELOW warningThreshold: type: string description: Stream alert rule metric warning threshold criticalThreshold: type: string description: Stream alert rule metric critical threshold description: Create Stream Alert Rules ResourceSelector: type: object properties: include: type: array description: | ### Supported metric names to use on filters with property /subject: * `*` - all events or metrics * `*/ports/` - port metrics * `*/connections/` - connection metrics * `*/metros/` - metro latency metrics items: type: string AlertRuleId: type: string description: Stream Alert Rule UUID format: uuid example: 0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15 AlertRulePutRequest: type: object properties: name: type: string description: Customer-provided stream name description: type: string description: Customer-provided stream description enabled: type: boolean description: Stream alert rule enabled status default: true metricName: type: string description: Stream alert rule metric name enum: - equinix.fabric.connection.bandwidth_tx.usage - equinix.fabric.connection.bandwidth_rx.usage - equinix.fabric.port.bandwidth_tx.usage - equinix.fabric.port.bandwidth_rx.usage - equinix.fabric.port.packets_erred_tx.count - equinix.fabric.port.packets_erred_rx.count - equinix.fabric.port.packets_dropped_tx.count - equinix.fabric.port.packets_dropped_rx.count - equinix.fabric.metro._.latency resourceSelector: $ref: "#/components/schemas/ResourceSelector" operand: type: string description: Stream alert rule metric operand enum: - ABOVE - BELOW windowSize: type: string description: Stream alert rule metric window size example: PT15M warningThreshold: type: string description: Stream alert rule metric warning threshold criticalThreshold: type: string description: Stream alert rule metric critical threshold description: Create Stream Alert Rules Error: required: - errorCode - errorMessage type: object properties: errorCode: pattern: ^EQ-\d{7}$ type: string errorMessage: type: string correlationId: type: string details: type: string help: type: string additionalInfo: type: array items: $ref: "#/components/schemas/PriceError_additionalInfo" description: Error Response with details CloudEventData: type: object properties: message: type: string description: Cloud Event message resource: $ref: "#/components/schemas/ResourceData" auth: $ref: "#/components/schemas/AuthContext" ResourceData: type: object properties: href: type: string description: Cloud Event asset href uuid: type: string description: Cloud Event asset uuid type: type: string description: Cloud Event asset type name: type: string description: Cloud Event asset name state: type: string description: Cloud Event asset state AuthContext: type: object properties: authtype: type: string description: Cloud Event auth type enum: - system - user authid: type: string description: Cloud Event auth identifier enum: - equinix - userId name: type: string description: Cloud Event username email: type: string description: Cloud Event email PaginationRequest: type: object properties: offset: minimum: 0 type: integer description: Index of the first element. default: 0 limit: minimum: 1 type: integer description: Number of elements to be requested per page. Number must be between 1 and 100, and the default is 20. default: 20 description: Pagination request information ConnectionType: type: string description: Connection type enum: - EVPL_VC - EPL_VC - EC_VC - IP_VC - ACCESS_EPL_VC - EIA_VC - EVPLAN_VC - EPLAN_VC - IPWAN_VC - IA_VC Order: type: object properties: purchaseOrderNumber: type: string description: Purchase order number customerReferenceNumber: type: string description: Customer reference number billingTier: type: string description: Billing tier for connection bandwidth orderId: type: string description: Order Identification orderNumber: type: string description: Order Reference Number termLength: maximum: 36 minimum: 1 type: integer description: Term length in months, valid values are 1, 12, 24, 36 where 1 is the default value (for on-demand case). default: 1 SimplifiedNotification: required: - emails - type type: object properties: type: type: string description: Notification Type example: BANDWIDTH_ALERT enum: - NOTIFICATION - BANDWIDTH_ALERT - CONNECTION_APPROVAL - PROFILE_LIFECYCLE - ALL - SALES_REP_NOTIFICATIONS sendInterval: type: string emails: type: array description: Array of contact emails items: type: string format: email registeredUsers: type: array description: Array of registered users items: type: string ConnectionRedundancy: type: object properties: group: type: string description: Redundancy group identifier (UUID of primary connection) priority: $ref: "#/components/schemas/ConnectionPriority" description: Connection redundancy configuration ConnectionSide: type: object properties: serviceToken: $ref: "#/components/schemas/ServiceToken" accessPoint: $ref: "#/components/schemas/AccessPoint" internetAccess: $ref: "#/components/schemas/InternetAccess" companyProfile: $ref: "#/components/schemas/ConnectionCompanyProfile" invitation: $ref: "#/components/schemas/ConnectionInvitation" additionalInfo: type: array description: Any additional information, which is not part of connection metadata or configuration items: $ref: "#/components/schemas/ConnectionSideAdditionalInfo" description: Connection configuration object for each side of multi-segment connection Project: required: - projectId type: object properties: projectId: type: string description: Subscriber-assigned project ID example: 44f4c4f8-2f39-494e-838c-d8e640591be5 ConnectionSideAdditionalInfo: type: object properties: key: type: string description: Key value: type: string description: Value description: Additional information marketplaceSubscription: type: object properties: href: type: string description: Marketplace Subscription URI format: uri readOnly: true example: https://api.equinix.com/fabric/v4/marketplaceSubscriptions/20d32a80-0d61-4333-bc03-707b591ae2f5 type: type: string description: Marketplace Subscription type example: AWS_MARKETPLACE_SUBSCRIPTION enum: - AWS_MARKETPLACE_SUBSCRIPTION - GCP_MARKETPLACE_SUBSCRIPTION - AZURE_MARKETPLACE_SUBSCRIPTION uuid: type: string description: Equinix-assigned Marketplace Subscription identifier example: 20d32a80-0d61-4333-bc03-707b591ae2f5 description: Equinix Fabric Entity for Marketplace Subscription EndCustomer: type: object properties: isDisclosed: type: boolean description: Indicate if endCustomer info should be disclosed or not default: false name: type: string mdmId: type: string ConnectionState: type: string description: Connection status enum: - ACTIVE - CANCELLED - DEPROVISIONED - DEPROVISIONING - DRAFT - FAILED - PENDING - PROVISIONED - PROVISIONING - REPROVISIONING - "" Change: required: - createdDateTime - type type: object properties: uuid: type: string description: Uniquely identifies a change type: type: string description: Type of change enum: - CONNECTION_CREATION - CONNECTION_UPDATE - CONNECTION_DELETION - CONNECTION_PROVIDER_STATUS_REQUEST status: type: string description: Current outcome of the change flow enum: - APPROVED - COMPLETED - FAILED - REJECTED - REQUESTED - SUBMITTED_FOR_APPROVAL createdDateTime: type: string description: Set when change flow starts format: date-time example: 2020-11-06T07:00:00Z updatedDateTime: type: string description: Set when change object is updated format: date-time example: 2020-11-06T07:00:00Z information: type: string description: Additional information data: $ref: "#/components/schemas/ConnectionChangeOperation" description: Current state of latest connection change ConnectionOperation: type: object properties: providerStatus: $ref: "#/components/schemas/ProviderStatus" equinixStatus: $ref: "#/components/schemas/EquinixStatus" operationalStatus: type: string description: Connection operational status enum: - UP - DOWN errors: type: array items: $ref: "#/components/schemas/Error" opStatusChangedAt: type: string description: When connection transitioned into current operational status format: date-time example: 2020-11-06T07:00:00Z description: Connection type-specific operational data SimplifiedAccount: type: object properties: accountNumber: type: integer description: Account number format: int64 accountName: type: string description: Account name orgId: type: integer description: Customer organization identifier format: int64 organizationName: type: string description: Customer organization name globalOrgId: type: string description: Global organization identifier globalOrganizationName: type: string description: Global organization name ucmId: type: string description: Account ucmId globalCustId: type: string description: Account name resellerAccountNumber: type: integer description: Reseller account number format: int64 resellerAccountName: type: string description: Reseller account name resellerUcmId: type: string description: Reseller account ucmId resellerOrgId: type: integer description: Reseller customer organization identifier format: int64 Changelog: type: object properties: createdBy: type: string description: Created by User Key example: johnsmith createdByFullName: type: string description: Created by User Full Name example: John Smith createdByEmail: type: string description: Created by User Email Address example: john.smith@example.com createdDateTime: type: string description: Created by Date and Time format: date-time example: 2020-11-06T07:00:00Z updatedBy: type: string description: Updated by User Key example: johnsmith updatedByFullName: type: string description: Updated by User Full Name example: John Smith updatedByEmail: type: string description: Updated by User Email Address example: john.smith@example.com updatedDateTime: type: string description: Updated by Date and Time format: date-time example: 2020-11-06T07:00:00Z deletedBy: type: string description: Deleted by User Key example: johnsmith deletedByFullName: type: string description: Deleted by User Full Name example: John Smith deletedByEmail: type: string description: Deleted by User Email Address example: john.smith@example.com deletedDateTime: type: string description: Deleted by Date and Time format: date-time example: 2020-11-06T07:00:00Z description: Change log ConnectionChangeOperation: required: - op - path - value type: object properties: op: type: string description: Handy shortcut for operation name example: add path: type: string description: path inside document leading to updated parameter example: /ipv6 value: type: object description: new value for updated parameter description: Connection change operation data Actions: type: string description: Connection action type enum: - CONNECTION_CREATION_ACCEPTANCE - CONNECTION_CREATION_REJECTION - CONNECTION_UPDATE_ACCEPTANCE - CONNECTION_UPDATE_REJECTION - CONNECTION_DELETION_ACCEPTANCE - CONNECTION_REJECTION_ACCEPTANCE - CONNECTION_UPDATE_REQUEST - MIGRATION_EVPL_VC - CONNECTION_PROVIDER_STATUS_REQUEST - CONNECTION_PROVIDER_BANDWIDTH_REQUEST - ACCEPT_HOSTED_CONNECTION - CANCEL_EVPL_VC_DRAFT_ORDERS ConnectionAcceptanceData: type: object properties: zSide: $ref: "#/components/schemas/ConnectionSide" providerBandwidth: type: integer description: Authorization key bandwidth in Mbps readOnly: true description: Connection acceptance data ConnectionRouteTableEntry: required: - changeLog - state - type type: object properties: type: $ref: "#/components/schemas/RouteTableEntryType" protocolType: $ref: "#/components/schemas/RouteTableEntryProtocolType" state: type: string example: ACTIVE enum: - ACTIVE - INACTIVE age: type: string example: PT5M30S prefix: type: string example: 192.168.10.0/24 nextHop: type: string example: 10.10.10.5 MED: type: integer example: 5 localPreference: type: integer example: 200 asPath: type: array items: type: string connection: $ref: "#/components/schemas/ConnectionRouteTableEntry_connection" changeLog: $ref: "#/components/schemas/Changelog" description: Advertised and received route table entry object BGPConnectionIpv4: required: - customerPeerIp - enabled type: object properties: customerPeerIp: type: string description: Customer side peering ip example: 10.1.1.2 equinixPeerIp: type: string description: Equinix side peering ip example: 10.1.1.3 enabled: type: boolean description: Admin status for the BGP session outboundASPrependCount: type: integer description: AS path prepend count format: int64 example: 3 inboundMED: type: integer description: Inbound Multi Exit Discriminator attribute format: int64 example: 1000 outboundMED: type: integer description: Outbound Multi Exit Discriminator attribute format: int64 example: 2000 routesMax: type: integer description: Maximum learnt prefixes limit format: int64 example: 1000 operation: $ref: "#/components/schemas/BGPConnectionOperation" BGPConnectionIpv6: required: - customerPeerIp - enabled type: object properties: customerPeerIp: type: string description: Customer side peering ip example: 2001:db8:c59b::1 equinixPeerIp: type: string description: Equinix side peering ip example: 2001:db8:c59b::1 enabled: type: boolean description: Admin status for the BGP session outboundASPrependCount: type: integer description: AS path prepend count format: int64 example: 3 inboundMED: type: integer description: Inbound Multi Exit Discriminator attribute format: int64 example: 1000 outboundMED: type: integer description: Outbound Multi Exit Discriminator attribute format: int64 example: 2000 routesMax: type: integer description: Maximum learnt prefixes limit format: int64 example: 1000 operation: $ref: "#/components/schemas/BGPConnectionOperation" RoutingProtocolBFD: required: - enabled type: object properties: enabled: type: boolean interval: type: string example: "100" DirectConnectionIpv4: type: object properties: equinixIfaceIp: type: string description: Equinix side Interface IP address example: 192.168.100.0/30 DirectConnectionIpv6: required: - equinixIfaceIp type: object properties: equinixIfaceIp: type: string description: Equinix side Interface IP address example: 2001:db8:c59b::/1 RoutingProtocolBGPData: type: object properties: type: type: string description: Routing protocol type enum: - BGP name: type: string example: My-BGP-route-1 bgpIpv4: $ref: "#/components/schemas/BGPConnectionIpv4" bgpIpv6: $ref: "#/components/schemas/BGPConnectionIpv6" customerAsn: type: integer description: Customer asn format: int64 example: 65002 equinixAsn: type: integer description: Equinix asn format: int64 example: 65002 bgpAuthKey: type: string description: BGP authorization key example: testAuthKey asOverrideEnabled: type: boolean description: Enable AS number override bfd: $ref: "#/components/schemas/RoutingProtocolBFD" href: type: string description: Routing Protocol URI format: uri example: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routingProtocols/69762051-85ed-4d13-b6b4-e32e93c672b5 uuid: type: string description: Routing protocol identifier format: uuid example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 state: type: string enum: - PROVISIONED - DEPROVISIONED - PROVISIONING - DEPROVISIONING - REPROVISIONING - FAILED operation: $ref: "#/components/schemas/RoutingProtocolOperation" change: $ref: "#/components/schemas/RoutingProtocolChange" changelog: $ref: "#/components/schemas/Changelog" RoutingProtocolDirectData: type: object properties: type: type: string description: Routing protocol type enum: - DIRECT name: type: string example: My-direct-route-1 directIpv4: $ref: "#/components/schemas/DirectConnectionIpv4" directIpv6: $ref: "#/components/schemas/DirectConnectionIpv6" href: type: string description: Routing Protocol URI format: uri example: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routingProtocols/69762051-85ed-4d13-b6b4-e32e93c672b5 uuid: type: string description: Routing protocol identifier format: uuid example: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 state: type: string enum: - PROVISIONED - DEPROVISIONED - PROVISIONING - DEPROVISIONING - REPROVISIONING - FAILED operation: $ref: "#/components/schemas/RoutingProtocolOperation" change: $ref: "#/components/schemas/RoutingProtocolChange" changelog: $ref: "#/components/schemas/Changelog" BGPActions: type: string description: BGP action type enum: - CLEAR_BGPIPV4 - CLEAR_BGPIPV6 - CLEAR_BGPIPV4_INBOUND - CLEAR_BGPIPV6_INBOUND - RESET_BGPIPV4 - RESET_BGPIPV6 BGPActionStates: type: string description: BGP action state enum: - PENDING - FAILED - SUCCEEDED RoutingProtocolChange: required: - type - uuid type: object properties: uuid: type: string description: Uniquely identifies a change type: type: string description: Type of change enum: - ROUTING_PROTOCOL_UPDATE - ROUTING_PROTOCOL_CREATION - ROUTING_PROTOCOL_DELETION href: type: string description: Routing Protocol Change URI format: uri description: Current state of latest Routing Protocol change RoutingProtocolChangeOperation: required: - op - path - value type: object properties: op: type: string description: Handy shortcut for operation name enum: - add - replace - remove path: type: string description: path inside document leading to updated parameter example: / value: $ref: "#/components/schemas/RoutingProtocolBase" description: Routing Protocol change operation data SortDirection: type: string description: Sorting direction default: DESC enum: - DESC - ASC SortBy: type: string description: Possible field names to use on sorting default: /changeLog/updatedDateTime enum: - /name - /direction - /aSide/accessPoint/name - /aSide/accessPoint/type - /aSide/accessPoint/account/accountName - /aSide/accessPoint/location/metroName - /aSide/accessPoint/location/metroCode - /aSide/accessPoint/linkProtocol/vlanCTag - /aSide/accessPoint/linkProtocol/vlanSTag - /zSide/accessPoint/name - /zSide/accessPoint/type - /zSide/accessPoint/account/accountName - /zSide/accessPoint/location/metroName - /zSide/accessPoint/location/metroCode - /zSide/accessPoint/linkProtocol/vlanCTag - /zSide/accessPoint/linkProtocol/vlanSTag - /zSide/accessPoint/authenticationKey - /bandwidth - /geoScope - /uuid - /changeLog/createdDateTime - /changeLog/updatedDateTime - /operation/equinixStatus - /operation/providerStatus - /redundancy/priority SortCriteriaResponse: type: object properties: direction: $ref: "#/components/schemas/SortDirection" property: $ref: "#/components/schemas/SortBy" Price: type: object properties: href: type: string description: An absolute URL that returns specified pricing data format: url type: $ref: "#/components/schemas/ProductType" code: type: string description: Equinix-assigned product code name: type: string description: Full product name description: type: string description: Product description account: $ref: "#/components/schemas/SimplifiedAccount" charges: type: array items: $ref: "#/components/schemas/PriceCharge" currency: type: string description: Product offering price currency termLength: type: integer description: In months. No value or value of 1 means on-demand enum: - 1 - 12 - 24 - 36 catgory: $ref: "#/components/schemas/PriceCategory" connection: $ref: "#/components/schemas/VirtualConnectionPrice" ipBlock: $ref: "#/components/schemas/IpBlockPrice" router: $ref: "#/components/schemas/FabricCloudRouterPrice" port: $ref: "#/components/schemas/VirtualPortPrice" timeService: $ref: "#/components/schemas/TimeServicePrice" ServiceProfileTypeEnum: type: string description: Service profile type example: L2_PROFILE enum: - L2_PROFILE - L3_PROFILE - IA_PROFILE ServiceProfileVisibilityEnum: type: string enum: - PRIVATE - PUBLIC SimplifiedLocation: type: object properties: metroHref: type: string example: https://api.equinix.com/fabric/v4/metros/AM region: type: string example: AMER, APAC, EMEA metroName: type: string example: Amsterdam metroCode: type: string example: AM ibx: type: string example: AM1 deprecated: true ServiceProfileStateEnum: type: string description: Equinix assigned state. example: ACTIVE enum: - ACTIVE - PENDING_APPROVAL - DELETED - REJECTED ServiceTokenType: type: string description: Type of Service Token enum: - VC_TOKEN - EPL_TOKEN ServiceTokenConnection: type: object properties: type: type: string description: Type of Connection enum: - EVPL_VC - EPL_VC - EVPLAN_VC - EPLAN_VC - IPWAN_VC - IP_VC href: type: string description: An absolute URL that is the subject of the link's context. format: uri readOnly: true uuid: type: string description: Equinix-assigned connection identifier format: uuid allowRemoteConnection: type: boolean description: Authorization to connect remotely default: false allowCustomBandwidth: type: boolean description: Allow custom bandwidth value default: false bandwidthLimit: maximum: 100000 minimum: 0 type: integer description: Connection bandwidth limit in Mbps supportedBandwidths: type: array description: List of permitted bandwidths. items: type: integer aSide: $ref: "#/components/schemas/ServiceTokenSide" zSide: $ref: "#/components/schemas/ServiceTokenSide" description: Service Token Connection Type Information ServiceTokenState: type: string description: Service token state enum: - ACTIVE - INACTIVE - EXPIRED - DELETED ServiceTokenChangeOperation: required: - op - path - value type: object properties: op: type: string description: Handy shortcut for operation name enum: - replace - add - remove path: type: string description: path inside document leading to updated parameter example: /expirationDateTime value: type: object description: new value for updated parameter description: Service Token change operation data ServiceTokenActions: type: string description: Service Token action type enum: - RESEND_EMAIL_NOTIFICATION PortType: type: string description: Type of Port enum: - XF_PORT - IX_PORT - IA_PORT PortState: type: string description: Port lifecycle state enum: - PENDING - PROVISIONING - REPROVISIONING - PROVISIONED - ACTIVE - DEPROVISIONING - DEPROVISIONED - INACTIVE - FAILED - ADDED - DELETED - TO_BE_ADDED - TO_BE_DELETED PortOrder: type: object properties: purchaseOrder: $ref: "#/components/schemas/PortOrder_purchaseOrder" orderId: type: string description: Order Identification customerReferenceId: type: string description: Customer order reference Id orderNumber: type: string description: Order Reference Number uuid: type: string description: Equinix-assigned order identifier, this is a derived response atrribute format: uuid signature: $ref: "#/components/schemas/PortOrder_signature" PortOperation: type: object properties: operationalStatus: type: string description: Availability of a given physical port. enum: - UP - DOWN - PARTIAL connectionCount: type: integer description: Total number of connections. format: int64 evplVCCount: type: integer description: Total number of connections. format: int64 fgVCCount: type: integer description: Total number of connections. format: int64 accessVCCount: type: integer description: Total number of connections. format: int64 opStatusChangedAt: type: string description: Date and time at which port availability changed. format: date-time example: 2020-11-06T07:00:00Z description: Operational specifications for ports. PortChange: type: object properties: uuid: type: string description: Uniquely identifies a change type: type: string description: Type of change enum: - PORT_CREATION - PORT_UPDATE - PORT_DELETION status: type: string description: Current outcome of the change flow enum: - COMPLETED - FAILED - REQUESTED information: type: string description: Additional information data: $ref: "#/components/schemas/PortChangeOperation" createdDateTime: type: string description: Set when change flow starts format: date-time example: 2020-11-06T07:00:00Z updatedDateTime: type: string description: Set when change object is updated format: date-time example: 2020-11-06T07:00:00Z description: Current state of latest port change PortDevice: type: object properties: name: type: string description: Device name redundancy: $ref: "#/components/schemas/PortDeviceRedundancy" description: Port device PortInterface: type: object properties: type: type: string description: Port interface type description: Port interface PortDemarcationPoint: type: object properties: cabinetUniqueSpaceId: type: string description: Port cabinet unique space id cageUniqueSpaceId: type: string description: Port cage unique space id patchPanel: type: string description: Port patch panel patchPanelName: type: string description: Port patch panel deprecated: true patchPanelPortA: type: string description: Port patch panel port A patchPanelPortB: type: string description: Port patch panel port B connectorType: type: string description: Port connector type ibx: type: string description: Port ibx identifier description: Customer physical Port PortRedundancy: type: object properties: enabled: type: boolean description: Access point redundancy group: type: string description: Port UUID of respective primary port deprecated: true priority: $ref: "#/components/schemas/PortPriority" description: Port redundancy configuration PortEncapsulation: type: object properties: type: type: string description: Port encapsulation protocol type enum: - "NULL" - DOT1Q - QINQ - UNTAGGED tagProtocolId: type: string description: Port encapsulation tag protocol identifier description: Port encapsulation configuration PortLag: type: object properties: id: type: string description: id enabled: type: boolean description: enabled deprecated: true name: type: string description: name memberStatus: type: string description: member status description: Port Lag Package: type: object properties: code: type: string description: Type of Port Package enum: - STANDARD - UNLIMITED - UNLIMITED_PLUS type: type: string description: Port service Type enum: - EPL - MSP description: Package settings for port PortSettings: type: object properties: buyout: type: boolean deprecated: true viewPortPermission: type: boolean deprecated: true placeVcOrderPermission: type: boolean deprecated: true layer3Enabled: type: boolean deprecated: true sharedPortType: type: boolean sharedPortProduct: type: string enum: - NETWORK_EDGE - VIRTUAL_GATEWAY - SMARTKEY - EDGE_METAL packageType: type: string description: Type of Port Package deprecated: true enum: - STANDARD - UNLIMITED - UNLIMITED_PLUS description: Port configuration settings PortNotification: required: - registeredUsers - type type: object properties: type: type: string description: Notification Type enum: - NOTIFICATION - TECHNICAL - PEERING - ESCALATION registeredUsers: type: array description: Array of registered users items: type: string PortAdditionalInfo: type: object properties: key: type: string description: Key value: type: string description: Value description: Additional information PortLoa: type: object properties: uuid: type: string description: uuid href: type: string description: Loa uri. format: uri readOnly: true type: type: string description: Loa type enum: - CTR_LOA description: Port Loas PhysicalPortType: type: string description: Type of Port enum: - XF_PHYSICAL_PORT PortTether: type: object properties: crossConnectId: type: string description: Port cross connect identifier cabinetNumber: type: string description: Port cabinet number systemName: type: string description: Port system name patchPanel: type: string description: Port patch panel patchPanelPortA: type: string description: Port patch panel port A patchPanelPortB: type: string description: Port patch panel port B ibx: type: string description: z-side/Equinix IBX description: Port physical connection PhysicalPortSettings: type: object properties: errorMessage: type: string packageType: type: string deprecated: true description: Physical Port configuration settings PortChangeOperation: required: - op - path - value type: object properties: op: type: string description: Handy shortcut for operation name example: replace path: type: string description: path inside document leading to updated parameter example: /name value: type: object description: new value for updated parameter description: Port change operation data LinkProtocolResponse: type: object properties: href: type: string description: LinkProtocol URI format: uri readOnly: true uuid: type: string description: Equinix-assigned network identifier format: uuid example: 92dc376a-a932-43aa-a6a2-c806dedbd784 state: $ref: "#/components/schemas/LinkProtocolState" type: $ref: "#/components/schemas/LinkProtocolRequestType" vlanTag: type: integer example: 20 vni: type: integer example: 20 vlanTagMin: type: integer example: 20 vlanTagMax: type: integer example: 200 vlanSTag: type: integer example: 20 vlanCTag: type: integer example: 20 vlanCTagMin: type: integer example: 20 vlanCTagMax: type: integer example: 200 subInterface: $ref: "#/components/schemas/SubInterface" asset: $ref: "#/components/schemas/LinkProtocolConnection" serviceToken: $ref: "#/components/schemas/LinkProtocolServiceToken" changeLog: $ref: "#/components/schemas/Changelog" description: Link Protocol response PortSortDirection: type: string description: Sorting direction default: DESC enum: - DESC - ASC PortSortBy: type: string description: Possible field names to use on sorting default: /device/name enum: - /device/name RouteFilterState: type: string description: Route Filter status enum: - PROVISIONING - REPROVISIONING - DEPROVISIONING - PROVISIONED - DEPROVISIONED - NOT_PROVISIONED - NOT_DEPROVISIONED RouteFiltersChange: required: - type - uuid type: object properties: uuid: type: string description: Uniquely identifies a change type: type: string description: Type of change enum: - BGP_IPv4_PREFIX_FILTER_UPDATE - BGP_IPv4_PREFIX_FILTER_CREATION - BGP_IPv4_PREFIX_FILTER_DELETION - BGP_IPv6_PREFIX_FILTER_UPDATE - BGP_IPv6_PREFIX_FILTER_CREATION - BGP_IPv6_PREFIX_FILTER_DELETION href: type: string description: Route filter change URI format: uri description: Current state of latest route filter change RouteFiltersPatchRequestItem: required: - op - path - value type: object properties: op: type: string description: Handy shortcut for operation name example: replace path: type: string description: path to change example: /name value: type: object description: new value for updated parameter description: Route filter change operation data RouteFiltersChangeOperation: required: - op - path - value type: object properties: op: type: string description: Handy shortcut for operation name enum: - add - replace - remove path: type: string description: path inside document leading to updated parameter example: / value: $ref: "#/components/schemas/RouteFiltersBase" description: Route filter change operation data RouteFilterConnectionsData: type: object properties: href: type: string description: Connection URI format: uri example: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f type: $ref: "#/components/schemas/ConnectionType" uuid: type: string description: Route filter identifier format: uuid example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d name: type: string example: connection-1 RouteFilterRuleState: type: string description: Route filter rule status enum: - PROVISIONING - REPROVISIONING - DEPROVISIONING - PROVISIONED - DEPROVISIONED - NOT_PROVISIONED - NOT_DEPROVISIONED RouteFilterRulesChange: required: - type - uuid type: object properties: uuid: type: string description: Uniquely identifies a change type: type: string description: Type of change enum: - BGP_IPv4_PREFIX_FILTER_RULE_UPDATE - BGP_IPv4_PREFIX_FILTER_RULE_CREATION - BGP_IPv4_PREFIX_FILTER_RULE_DELETION - BGP_IPv6_PREFIX_FILTER_RULE_UPDATE - BGP_IPv6_PREFIX_FILTER_RULE_CREATION - BGP_IPv6_PREFIX_FILTER_RULE_DELETION href: type: string description: Route Filter Change URI format: uri description: Current state of latest route filter rule change RouteFilterRulesPatchRequestItem: required: - op - path - value type: object properties: op: type: string description: Handy shortcut for operation name example: replace path: type: string description: path to change example: /prefixMatch value: type: object description: new value for updated parameter description: Route filter rule change operation data RouteFilterRulesChangeOperation: required: - op - path - value type: object properties: op: type: string description: Handy shortcut for operation name enum: - add - replace - remove path: type: string description: path inside document leading to updated parameter example: / value: $ref: "#/components/schemas/RouteFilterRulesBase" description: Route filter rule change operation data RouteAggregationState: type: string description: Route Aggregation status enum: - PROVISIONING - REPROVISIONING - DEPROVISIONING - PROVISIONED - DEPROVISIONED - NOT_PROVISIONED - NOT_DEPROVISIONED RouteAggregationsChange: required: - type - uuid type: object properties: uuid: type: string description: Uniquely identifies a change type: type: string description: Type of change enum: - BGP_IPv4_PREFIX_AGGREGATION_UPDATE - BGP_IPv4_PREFIX_AGGREGATION_CREATION - BGP_IPv4_PREFIX_AGGREGATION_DELETION - BGP_IPv6_PREFIX_AGGREGATION_UPDATE - BGP_IPv6_PREFIX_AGGREGATION_CREATION - BGP_IPv6_PREFIX_AGGREGATION_DELETION href: type: string description: Route AGGREGATION Change URI format: uri description: Current state of latest Route Aggregation change RouteAggregationsPatchRequestItem: required: - op - path - value type: object properties: op: type: string description: Handy shortcut for operation name example: replace path: type: string description: path to change example: /name value: type: object description: new value for updated parameter description: Route Aggregation change operation data RouteAggregationsChangeOperation: required: - op - path - value type: object properties: op: type: string description: Handy shortcut for operation name enum: - add - replace - remove path: type: string description: path inside document leading to updated parameter example: / value: $ref: "#/components/schemas/RouteAggregationsBase" description: Route Aggregation change operation data RouteAggregationConnectionsData: type: object properties: href: type: string description: Connection URI format: uri example: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f type: $ref: "#/components/schemas/ConnectionType" uuid: type: string description: Route Aggregation identifier format: uuid example: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d name: type: string example: connection-1 RouteAggregationRuleState: type: string description: Route Aggregation Rule status enum: - PROVISIONING - REPROVISIONING - DEPROVISIONING - PROVISIONED - DEPROVISIONED - NOT_PROVISIONED - NOT_DEPROVISIONED RouteAggregationRulesChange: required: - type - uuid type: object properties: uuid: type: string description: Uniquely identifies a change type: type: string description: Type of change enum: - BGP_IPv4_PREFIX_AGGREGATION_RULE_UPDATE - BGP_IPv4_PREFIX_AGGREGATION_RULE_CREATION - BGP_IPv4_PREFIX_AGGREGATION_RULE_DELETION href: type: string description: Route Aggregation Change URI format: uri description: Current state of latest Route Aggregation Rule change RouteAggregationRulesPatchRequestItem: required: - op - path - value type: object properties: op: type: string description: Handy shortcut for operation name example: replace path: type: string description: path to change example: /prefix value: type: object description: new value for updated parameter description: Route Aggregation Rule change operation data RouteAggregationRulesChangeOperation: required: - op - path - value type: object properties: op: type: string description: Handy shortcut for operation name enum: - add - replace - remove path: type: string description: path inside document leading to updated parameter example: / value: $ref: "#/components/schemas/RouteAggregationRulesBase" description: Route Aggregation Rule change operation data SimplifiedLocationWithoutIBX: required: - metroCode type: object properties: metroHref: type: string description: The Canonical URL at which the resource resides. example: https://api.equinix.com/fabric/v4/metros/AM region: type: string example: AMER, APAC, EMEA metroName: type: string example: Amsterdam metroCode: type: string example: AM CloudRouterPostRequestPackage: required: - code type: object properties: href: type: string description: Fabric Cloud Router URI format: uri example: https://api.equinix.com/fabric/v4/routerPackages/LAB type: type: string description: Cloud Router package type example: ROUTER_PACKAGE enum: - ROUTER_PACKAGE code: type: string description: Cloud Router package code example: LAB enum: - LAB - ADVANCED - STANDARD - PREMIUM description: Fabric Cloud Router Package Type CloudRouterAccessPointState: type: string description: Access point lifecycle state enum: - PROVISIONED - PROVISIONING - DEPROVISIONING - DEPROVISIONED - REPROVISIONING - NOT_PROVISIONED - NOT_DEPROVISIONED CloudRouterChange: required: - type - updatedDateTime type: object properties: uuid: type: string description: Uniquely identifies a change type: type: string description: Type of change enum: - ROUTER_UPDATE - ROUTER_PACKAGE_UPDATE status: type: string description: Current outcome of the change flow enum: - COMPLETED - FAILED - REQUESTED createdDateTime: type: string description: Set when change flow starts format: date-time example: 2020-11-06T07:00:00Z updatedDateTime: type: string description: Set when change object is updated format: date-time example: 2020-11-06T07:00:00Z information: type: string description: Additional information data: $ref: "#/components/schemas/CloudRouterChangeOperation" description: Current state of latest CloudRouter change CloudRouterChangeOperation: required: - op - path - value type: object properties: op: type: string description: Handy shortcut for operation name enum: - replace - add - remove path: type: string description: path inside document leading to updated parameter value: type: object description: new value for updated parameter description: Fabric Cloud Router change operation data CloudRouterActionType: type: string description: Cloud router action type enum: - BGP_SESSION_STATUS_UPDATE - ROUTE_TABLE_ENTRY_UPDATE - RECEIVED_ROUTE_ENTRY_UPDATE - ADVERTISED_ROUTE_ENTRY_UPDATE RouterActionsConnection: type: object properties: uuid: type: string description: Connection UUID example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 description: Connection object for router actions Operation: type: object properties: bgpIpv4RoutesCount: type: integer description: IPV4 route count example: 6 bgpIpv6RoutesCount: type: integer description: IPV6 route count example: 6 description: Operation object for router actions CloudRouterCommandType: type: string description: Fabric Cloud Router Command Type example: PING_COMMAND enum: - PING_COMMAND CloudRouterCommandRequest: required: - destination type: object properties: destination: type: string description: Fabric Cloud Router Ping Command Destination example: 8.8.8.8 sourceConnection: $ref: "#/components/schemas/CloudRouterCommandRequestConnection" timeout: type: integer description: Fabric Cloud Router Ping Command Timeout example: 5 dataBytes: maximum: 9000 minimum: 16 type: integer description: Fabric Cloud Router Ping Command DataBytes example: 100 default: 64 interval: type: integer description: Time in milliseconds between sending each packet readOnly: true example: 1000 default: 1000 count: type: integer description: Total number of ping requests readOnly: true example: 5 default: 5 description: Fabric Cloud Router Command Request CloudRouterCommandState: type: string description: Fabric Cloud Router Command State example: SUCCEEDED enum: - PENDING - SUCCEEDED - FAILED - DELETED CloudRouterCommandResponse: type: object properties: output: type: string outputStructuredPing: $ref: "#/components/schemas/OutputStructuredPing" RouteTableEntry: required: - changeLog - state - type type: object properties: type: $ref: "#/components/schemas/RouteTableEntryType" protocolType: $ref: "#/components/schemas/RouteTableEntryProtocolType" state: $ref: "#/components/schemas/RouteTableEntryState" age: type: string example: PT5M30S prefix: type: string example: 192.168.10.0/24 nextHop: type: string example: 10.10.10.5 MED: type: integer example: 5 localPreference: type: integer example: 200 asPath: type: array items: type: string connection: $ref: "#/components/schemas/ConnectionRouteTableEntry_connection" changeLog: $ref: "#/components/schemas/Changelog" description: Route table entry object code: type: string description: Cloud Router package code example: LAB enum: - LAB - ADVANCED - STANDARD - PREMIUM PackageChangeLog: type: object properties: createdDateTime: type: string format: date-time example: 2020-11-06T07:00:00Z updatedDateTime: type: string format: date-time example: 2020-11-06T07:00:00Z description: Cloud Router package change log ApiServices: type: object properties: route: type: string description: service routes status: type: string description: service status changedDateTime: type: string description: service status change date description: Available services details ValidateConnectionResponse: type: object properties: uuid: type: string description: Equinix-assigned connection identifier bandwidth: maximum: 50000 minimum: 0 type: integer description: Connection bandwidth in Mbps redundancy: $ref: "#/components/schemas/ConnectionRedundancy" aSide: $ref: "#/components/schemas/ConnectionSide" zSide: $ref: "#/components/schemas/ConnectionSide" description: Validate Connection specification NetworkType: type: string description: Network type enum: - EVPLAN - EPLAN - IPWAN - EVPTREE - EPTREE NetworkScope: type: string description: Network scope enum: - REGIONAL - GLOBAL - LOCAL NetworkState: type: string description: Network status example: ACTIVE enum: - ACTIVE - INACTIVE - DELETED SimplifiedNetworkChange: type: object properties: href: type: string description: Network URI format: uri readOnly: true example: https://api.equinix.com/fabric/v4/networks/2a4fb415-5a7f-436f-bae6-02f5e403deec/changes/4b17da68-3d6b-436d-9c8f-2105f3b950d9 uuid: type: string description: Uniquely identifies a change format: uuid example: 4b17da68-3d6b-436d-9c8f-2105f3b950d9 type: $ref: "#/components/schemas/NetworkChangeType" description: Current state of latest network change NetworkOperation: type: object properties: equinixStatus: $ref: "#/components/schemas/NetworkEquinixStatus" description: Network operational data Link: type: object properties: href: type: string description: Resource URI format: uri readOnly: true rel: type: string description: OperationId from Swagger hub spec method: type: string description: Http method type contentType: type: string description: Content type for the response authenticate: type: boolean description: Authentication required or not NetworkChangeOperation: required: - op - path - value type: object properties: op: type: string description: Handy shortcut for operation name enum: - replace - add - remove path: type: string description: path inside document leading to updated parameter example: /name value: type: object description: new value for updated parameter description: Network change operation data NetworkSortCriteriaResponse: type: object properties: direction: $ref: "#/components/schemas/NetworkSortDirectionResponse" property: $ref: "#/components/schemas/NetworkSortByResponse" NetworkChangeType: type: string description: Type of change enum: - NETWORK_CREATION - NETWORK_UPDATE - NETWORK_DELETION NetworkChangeStatus: type: string description: Current outcome of the change flow enum: - APPROVED - COMPLETED - FAILED - REJECTED - REQUESTED - SUBMITTED_FOR_APPROVAL precisionTimePackageRequest: title: precisionTimePackageRequest required: - code type: object properties: code: type: string description: Precision Time Service Level enum: - NTP_STANDARD - NTP_ENTERPRISE - PTP_STANDARD - PTP_ENTERPRISE description: Precision Time Service Level Request example: code: NTP_STANDARD virtualConnectionUuid: title: fabricConnectionUuid required: - uuid type: object properties: href: type: string description: Connection URI format: uri readOnly: true type: type: string description: Connection Type uuid: type: string description: Connection UUID. format: uuid description: UUID of the Fabric Connection Instance example: uuid: 095be615-a8ad-4c33-8e9c-c7612fbf6c9f ipv4: title: ipv4 required: - networkMask - primary - secondary type: object properties: primary: type: string description: Primary Timing Server IP Address format: ipv4 secondary: type: string description: Secondary Timing Server IP Address format: ipv4 networkMask: type: string description: Network Mask format: ipv4 defaultGateway: type: string description: Gateway Interface IP address format: ipv4 description: EPT service network information example: primary: 10.0.0.1 secondary: 10.0.0.2 networkMask: 255.255.255.240 defaultGateway: 10.0.0.3 ntpAdvanceConfiguration: type: array description: NTP Advanced configuration - MD5 Authentication. items: $ref: "#/components/schemas/md5" ptpAdvanceConfiguration: type: object properties: timeScale: type: string description: Time Scale value, ARB denotes Arbitrary and PTP denotes Precision Time Protocol. example: ARB enum: - ARB - PTP domain: maximum: 127 minimum: 0 type: integer description: The PTP domain value. example: 0 priority1: maximum: 248 minimum: 0 type: integer description: The priority1 value determines the best primary clock, Lower value indicates higher priority. example: 128 priority2: maximum: 248 minimum: 0 type: integer description: The priority2 value differentiates and prioritizes the primary clock to avoid confusion when priority1-value is the same for different primary clocks in a network. example: 128 logAnnounceInterval: type: integer description: Logarithmic value that controls the rate of PTP Announce packets from the PTP time server. Default is 1 (1 packet every 2 seconds), Unit packets/second. example: 1 enum: - -3 - -2 - -1 - 0 - 1 logSyncInterval: type: integer description: Logarithmic value that controls the rate of PTP Sync packets. Default is -4 (16 packets per second), Unit packets/second.. example: -4 enum: - -5 - -4 - -3 - -2 - -1 - 0 - 1 logDelayReqInterval: type: integer description: Logarithmic value that controls the rate of PTP DelayReq packets. Default is -4 (16 packets per second), Unit packets/second.. example: -4 enum: - -5 - -4 - -3 - -2 - -1 - 0 - 1 transportMode: type: string enum: - MULTICAST - UNICAST - HYBRID grantTime: maximum: 7200 minimum: 30 type: integer description: Unicast Grant Time in seconds. For Multicast and Hybrid transport modes, grant time defaults to 300 seconds. For Unicast mode, grant time can be between 30 to 7200. example: 300 description: PTP Advanced Configuration. precisionTimeOrder: title: precisionTimeOrder type: object properties: purchaseOrderNumber: type: string description: Purchase order number customerReferenceNumber: type: string description: Customer reference number orderNumber: type: string description: Order Reference Number description: Precision Time Order precisionTimePackagePostResponse: title: precisionTimePackagePostResponse required: - code type: object properties: href: type: string format: uri code: type: string enum: - NTP_STANDARD - NTP_ENTERPRISE - PTP_STANDARD - PTP_ENTERPRISE example: href: https://api.equinix.com/fabric/v4/timeServicePackage/NTP_STANDARD code: NTP_STANDARD virtualConnectionTimeServiceResponse: title: fabricConnectionResponse type: object properties: href: type: string description: Connection URI format: uri readOnly: true type: type: string description: Connection Type. uuid: type: string description: Connection UUID. format: uuid aSide: $ref: "#/components/schemas/virtualConnectionSide" zSide: $ref: "#/components/schemas/virtualConnectionSide" description: Fabric Connection Precision Time Service Response Object precisionTimePrice: title: precisionTimePrice type: object properties: currency: type: string description: offering price currency charges: type: array items: $ref: "#/components/schemas/PriceCharge" description: Precision Time Price connectionLink: type: object properties: href: type: string format: uri example: https://api.equinix.com/fabric/v4/timeServices/92dc376a-a932-43aa-a6a2-c806dedbd784/connections type: type: string enum: - EVPL_VC uuid: type: string format: uuid StreamSubscriptionFilter: type: object properties: and: maxItems: 8 type: array items: $ref: "#/components/schemas/StreamFilter" StreamFilter: type: object anyOf: - $ref: "#/components/schemas/StreamFilterSimpleExpression" - $ref: "#/components/schemas/StreamFilterOrFilter" StreamFilterSimpleExpression: type: object properties: property: type: string description: | Possible field names to use on filters: * `/subject` - subject * `/type` - type example: /type operator: type: string description: | Possible operators to use on filters: * `=` - equal * `in` - in * `LIKE` - case-sensitive like * `ILIKE` - case-insensitive like example: = values: type: array description: | ### Supported event or metric names to use on filters with property /type: * `*` - all events or metrics * `equinix.fabric.port.*` - port events or metrics * `equinix.fabric.connection.*` - connection events or metrics * `equinix.fabric.router.*` - cloud router events * `equinix.fabric.metro.*` - metro metrics * `equinix.fabric.network.*` - network events * `equinix.fabric.service_token.*` - service token events * `equinix.network_edge.*` - network edge events * `equinix.network_edge.acl.*` - network edge acl events * `equinix.network_edge.device.*` - network edge device events * `equinix.access_manager.*` - identity access manager events * `equinix.access_manager.user.role.*` - identity access manager user role events ### Supported event or metric names to use on filters with property /subject: * `*` - all events or metrics * `/fabric/v4/ports/` - port events or metrics * `/fabric/v4/connections/` - connection events or metrics * `/fabric/v4/routers/` - cloud router events * `/fabric/v4/metros/` - metro metrics * `/fabric/v4/networks/` - network events * `/fabric/v4/tokens/` - service token events * `/ne/v1/acl/` - network edge acl events * `/ne/v1/devices/` - network edge device events * `/am/v2/users//roleAssignments/` - identity access manager events items: type: string StreamFilterOrFilter: type: object properties: or: maxItems: 3 type: array items: $ref: "#/components/schemas/StreamFilterSimpleExpression" ConnectionPriority: type: string description: Connection priority in redundancy group enum: - PRIMARY - SECONDARY AccessPoint: type: object properties: type: $ref: "#/components/schemas/AccessPointType" account: $ref: "#/components/schemas/SimplifiedAccount" location: $ref: "#/components/schemas/SimplifiedLocation" port: $ref: "#/components/schemas/SimplifiedPort" profile: $ref: "#/components/schemas/SimplifiedServiceProfile" router: $ref: "#/components/schemas/CloudRouter" linkProtocol: $ref: "#/components/schemas/SimplifiedLinkProtocol" virtualDevice: $ref: "#/components/schemas/VirtualDevice" interface: $ref: "#/components/schemas/Interface" network: $ref: "#/components/schemas/SimplifiedNetwork" sellerRegion: type: string description: Access point seller region peeringType: $ref: "#/components/schemas/PeeringType" authenticationKey: type: string description: Access point authentication key providerConnectionId: type: string description: Provider assigned Connection Id virtualNetwork: $ref: "#/components/schemas/VirtualNetwork" interconnection: $ref: "#/components/schemas/MetalInterconnection" vpic_interface: $ref: "#/components/schemas/VpicInterface" description: Access point object InternetAccess: type: object properties: uuid: type: string description: Internet Access Service Identifier format: uuid description: Internet Access Details ConnectionCompanyProfile: type: object properties: id: type: number description: company profile identifier example: 1 name: type: string description: company profile name example: Company-1 globalOrgId: type: string description: global customer organization value description: Connection Company Profile Details ConnectionInvitation: type: object properties: email: type: string description: invitee email example: test@equinix.com message: type: string description: invitation message example: Hello, Please accept my invitation ctrDraftOrderId: type: string description: draft order id for invitation description: Connection Invitation Details ProviderStatus: type: string description: Connection provider readiness status enum: - AVAILABLE - DEPROVISIONED - DEPROVISIONING - FAILED - NOT_AVAILABLE - PENDING_APPROVAL - PENDING_CONFIGURATION - PROVISIONED - PROVISIONING - REJECTED - PENDING_BGP - OUT_OF_BANDWIDTH - DELETED - ERROR - ERRORED - NOTPROVISIONED - NOT_PROVISIONED - ORDERING - DELETING - PENDING DELETE - N/A EquinixStatus: type: string description: Connection status enum: - REJECTED_ACK - REJECTED - PENDING_DELETE - PROVISIONED - BEING_REPROVISIONED - BEING_DEPROVISIONED - BEING_PROVISIONED - CREATED - ERRORED - PENDING_DEPROVISIONING - APPROVED - ORDERING - PENDING_APPROVAL - NOT_PROVISIONED - DEPROVISIONING - NOT_DEPROVISIONED - PENDING_AUTO_APPROVAL - PROVISIONING - PENDING_BGP_PEERING - PENDING_PROVIDER_VLAN - DEPROVISIONED - DELETED - PENDING_BANDWIDTH_APPROVAL - AUTO_APPROVAL_FAILED - UPDATE_PENDING - DELETED_API - MODIFIED - PENDING_PROVIDER_VLAN_ERROR - DRAFT - CANCELLED - PENDING_INTERFACE_CONFIGURATION RouteTableEntryType: type: string description: Route table entry type enum: - IPv4_BGP_ROUTE - IPv4_STATIC_ROUTE - IPv4_DIRECT_ROUTE - IPv6_BGP_ROUTE - IPv6_STATIC_ROUTE - IPv6_DIRECT_ROUTE RouteTableEntryProtocolType: type: string description: Route table entry protocol type enum: - BGP - STATIC - DIRECT BGPConnectionOperation: type: object properties: operationalStatus: type: string description: BGP IPv4 or IPv6 Connection State operational status enum: - UP - DOWN - UNKNOWN opStatusChangedAt: type: string description: Last BGP State Update by Date and Time format: date-time example: 2021-10-30T07:21:39Z description: BGP IPv4 or IPv6 Connection State operational data RoutingProtocolOperation: type: object properties: errors: type: array items: $ref: "#/components/schemas/Error" ProductType: type: string description: Product type enum: - VIRTUAL_CONNECTION_PRODUCT - IP_BLOCK_PRODUCT - VIRTUAL_PORT_PRODUCT - CLOUD_ROUTER_PRODUCT - PRECISION_TIME_PRODUCT PriceCharge: type: object properties: type: type: string description: Price charge type enum: - MONTHLY_RECURRING - NON_RECURRING price: minimum: 0 type: number description: Offering price format: double description: Price Charge PriceCategory: type: string description: Price category enum: - COUNTRY - CUSTOMER VirtualConnectionPrice: type: object properties: uuid: type: string description: Either uuid or rest of attributes are required format: uuid type: $ref: "#/components/schemas/VirtualConnectionPriceConnectionType" bandwidth: minimum: 0 type: integer aSide: $ref: "#/components/schemas/VirtualConnectionPriceASide" zSide: $ref: "#/components/schemas/VirtualConnectionPriceZSide" description: Virtual Connection Product configuration IpBlockPrice: type: object properties: uuid: type: string description: Either uuid or rest of attributes are required format: uuid type: $ref: "#/components/schemas/IpBlockType" prefixLength: type: integer location: $ref: "#/components/schemas/PriceLocation" description: IP Block Product configuration FabricCloudRouterPrice: type: object properties: uuid: type: string description: Unique identifier assigned to the Cloud Router format: uuid location: $ref: "#/components/schemas/PriceLocation" package: $ref: "#/components/schemas/FabricCloudRouterPackages" description: Cloud Router Product configuration VirtualPortPrice: type: object properties: uuid: type: string description: Unique identifier assigned to the virtual port. Either the uuid or the remaining attributes must be supplied. format: uuid type: $ref: "#/components/schemas/VirtualPortType" location: $ref: "#/components/schemas/VirtualPortLocation" lag: $ref: "#/components/schemas/LinkAggregationGroup" physicalPortsQuantity: type: integer description: Number of physical ports requested. The defaults is 1. default: 1 bandwidth: type: integer description: Aggregated data transfer capacity, expressed as follows
-> Mbps, megabits (1 million bits) per second
-> Gbps, gigabits (1 billion bits) per second
Bandwidth must be divisible by physicalPortsQuantity. redundancy: $ref: "#/components/schemas/VirtualPortRedundancy" connectivitySource: $ref: "#/components/schemas/ConnectivitySource" serviceType: $ref: "#/components/schemas/VirtualPortServiceType" settings: $ref: "#/components/schemas/VirtualPortConfiguration" description: Preferences and settings for a virtual port connected to an internet service provider (ISP) or other Equinix platform entity. TimeServicePrice: type: object properties: type: type: string description: Precision Time Service Type refers to the corresponding Protocol. enum: - NTP - PTP package: $ref: "#/components/schemas/precisionTimePackageRequest" connection: $ref: "#/components/schemas/TimeServicePriceConnection" description: Time Service Product configuration ServiceTokenSide: type: object properties: accessPointSelectors: type: array description: List of AccessPointSelectors items: $ref: "#/components/schemas/AccessPointSelector" description: Connection link protocol,virtual device or network configuration PortDeviceRedundancy: type: object properties: group: type: string description: Device redundancy group priority: type: string description: Device redundancy priority enum: - PRIMARY - SECONDARY description: Device redundancy PortPriority: type: string description: Port priority in redundancy group enum: - PRIMARY - SECONDARY LinkProtocolState: type: string description: Network status enum: - RESERVED - RELEASED LinkProtocolRequestType: type: string description: Type of Link Protocol enum: - UNTAGGED - DOT1Q - QINQ - VXLAN SubInterface: type: object properties: name: type: string description: name of subinterafce of a port unit: type: integer example: 200 description: Sub Interface information LinkProtocolConnection: type: object properties: href: type: string description: Connection URI format: uri readOnly: true uuid: type: string format: string example: cd67f685-41b0-1b07-6de0-320a5c00abe type: type: string example: EVPL_VC bandwidth: type: integer format: int64 example: 100 description: Connection details of Link Protocol LinkProtocolServiceToken: type: object properties: href: type: string description: Service Token URI format: uri readOnly: true uuid: type: string format: uuid example: cd67f685-41b0-1b07-6de0-0320a5c00abe type: type: string example: TOKEN bandwidth: type: integer format: int64 example: 1000 description: Service Token details of Link Protocol CloudRouterCommandRequestConnection: type: object properties: uuid: type: string description: Connection UUID example: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 description: Connection object for Cloud Router Command OutputStructuredPing: type: object properties: destinationIp: type: string example: 8.8.8.8 destinationName: type: string example: 8.8.8.8 dataBytes: type: integer example: 100 packetsTransmitted: type: integer example: 4 packetsReceived: type: integer example: 4 packetsLossPercent: type: number format: float example: 0 rttMin: type: number format: float example: 9.271 rttAvg: type: number format: float example: 15.483 rttMax: type: number format: float example: 26.771 rttStdDev: type: number format: float example: 7.039 responses: type: array items: $ref: "#/components/schemas/OutputStructuredPingResponseItem" RouteTableEntryState: type: string description: Route table entry state enum: - ACTIVE NetworkEquinixStatus: type: string description: Network status enum: - PROVISIONING - PROVISIONED - NOT_PROVISIONED - DEPROVISIONING - DEPROVISIONED - NOT_DEPROVISIONED NetworkSortDirectionResponse: type: string description: Sorting direction default: DESC enum: - DESC - ASC NetworkSortByResponse: type: string description: Possible field names to use on sorting default: /changeLog/updatedDateTime enum: - /name - /type - /uuid - /state - /scope - /location/region - /changeLog/createdDateTime - /changeLog/updatedDateTime md5: type: object properties: type: type: string enum: - ASCII - HEX keyNumber: maximum: 65535 minimum: 1 type: integer description: The authentication Key ID. example: 10 key: maxLength: 40 minLength: 10 type: string description: The plaintext authentication key. For ASCII type, the key must contain printable ASCII characters, range 10-20 characters. For HEX type, range should be 10-40 characters. virtualConnectionSide: title: fabricConnectionAccessPoint type: object properties: accessPoint: $ref: "#/components/schemas/AccessPoint" description: Fabric Connection access point object. AccessPointType: type: string description: Access point type enum: - VD - VG - SP - IGW - COLO - SUBNET - CLOUD_ROUTER - NETWORK - METAL_NETWORK - VPIC_INTERFACE SimplifiedPort: type: object properties: href: type: string description: Equinix assigned response attribute for an absolute URL that is the subject of the link's context. format: uri readOnly: true type: $ref: "#/components/schemas/PortType" id: type: integer description: Equinix assigned response attribute for Port Id uuid: type: string description: Equinix assigned response attribute for port identifier format: uuid name: type: string description: Equinix assigned response attribute for Port name description: type: string description: Equinix assigned response attribute for Port description physicalPortsSpeed: minimum: 0 type: integer description: Physical Ports Speed in Mbps connectionsCount: minimum: 0 type: integer description: Equinix assigned response attribute for Connection count project: $ref: "#/components/schemas/Project" state: $ref: "#/components/schemas/PortState" operation: $ref: "#/components/schemas/PortOperation" account: $ref: "#/components/schemas/SimplifiedAccount" serviceType: type: string description: Port service Type deprecated: true enum: - EPL - MSP bandwidth: minimum: 0 type: integer description: Equinix assigned response attribute for Port bandwidth in Mbps format: int64 availableBandwidth: minimum: 0 type: integer description: Equinix assigned response attribute for Port available bandwidth in Mbps format: int64 usedBandwidth: minimum: 0 type: integer description: Equinix assigned response attribute for Port used bandwidth in Mbps format: int64 location: $ref: "#/components/schemas/SimplifiedLocation" device: $ref: "#/components/schemas/PortDevice" interface: $ref: "#/components/schemas/PortInterface" tether: $ref: "#/components/schemas/PortTether" demarcationPoint: $ref: "#/components/schemas/PortDemarcationPoint" redundancy: $ref: "#/components/schemas/PortRedundancy" encapsulation: $ref: "#/components/schemas/PortEncapsulation" lagEnabled: type: boolean description: If LAG enabled package: $ref: "#/components/schemas/Package" settings: $ref: "#/components/schemas/PortSettings" physicalPortQuantity: type: integer description: Number of physical ports additionalInfo: type: array description: Port additional information items: $ref: "#/components/schemas/PortAdditionalInfo" physicalPorts: type: array description: Physical ports that implement this port items: $ref: "#/components/schemas/PhysicalPort" description: Port specification SimplifiedLinkProtocol: type: object properties: type: $ref: "#/components/schemas/LinkProtocolType" vlanTag: maximum: 4092 minimum: 2 type: integer description: vlanTag value specified for DOT1Q connections vlanSTag: maximum: 4092 minimum: 2 type: integer description: vlanSTag value specified for QINQ connections vlanCTag: maximum: 4092 minimum: 2 type: integer description: vlanCTag value specified for QINQ connections description: Connection link protocol Configuration VirtualDevice: type: object properties: href: type: string description: Virtual Device URI format: uri readOnly: true uuid: type: string description: Equinix-assigned Virtual Device identifier format: uuid name: type: string description: Customer-assigned Virtual Device name type: type: string description: Virtual Device type enum: - EDGE account: $ref: "#/components/schemas/SimplifiedAccount" description: Virtual Device AccessPoint Information Interface: type: object properties: href: type: string description: Interface URI format: uri readOnly: true uuid: type: string description: Equinix-assigned Interface identifier format: uuid id: type: integer description: Interface id type: type: string description: Interface type enum: - CLOUD - NETWORK projectId: type: string description: Interface Project ID description: Interface Information SimplifiedNetwork: required: - uuid type: object properties: href: type: string description: Network URI format: uri readOnly: true example: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784 uuid: type: string description: Equinix-assigned network identifier format: uuid example: 92dc376a-a932-43aa-a6a2-c806dedbd784 name: type: string description: Customer-assigned network name example: My EVPLAN Network state: $ref: "#/components/schemas/NetworkState" account: $ref: "#/components/schemas/SimplifiedAccount" change: $ref: "#/components/schemas/SimplifiedNetworkChange" operation: $ref: "#/components/schemas/NetworkOperation" changeLog: $ref: "#/components/schemas/Changelog" links: type: array description: Network sub-resources links readOnly: true items: $ref: "#/components/schemas/Link" type: $ref: "#/components/schemas/NetworkType" scope: $ref: "#/components/schemas/NetworkScope" location: $ref: "#/components/schemas/SimplifiedLocation" description: Network specification PeeringType: type: string description: Access point peering type enum: - PRIVATE - MICROSOFT - PUBLIC - MANUAL VirtualNetwork: type: object properties: href: type: string description: The Canonical URL at which the resource resides. format: uri readOnly: true uuid: type: string description: Equinix-assigned Virtual Network identifier format: uuid description: Virtual Network Information MetalInterconnection: type: object properties: uuid: type: string description: Equinix Metal Interconnection format: uuid description: Metal Interconnection VpicInterface: type: object properties: href: type: string description: The Canonical URL at which the resource resides. format: uri readOnly: true uuid: type: string description: MCN assigned VPIC Interface Identifier format: uuid description: MCN VPIC Interface Information VirtualConnectionPriceConnectionType: type: string description: Virtual Connection type enum: - EVPL_VC - EPL_VC - EC_VC - IP_VC - VD_CHAIN_VC - ACCESS_EPL_VC - EVPLAN_VC - EPLAN_VC - IPWAN_VC - IA_VC VirtualConnectionPriceASide: type: object properties: accessPoint: $ref: "#/components/schemas/VirtualConnectionPriceASide_accessPoint" VirtualConnectionPriceZSide: type: object properties: accessPoint: $ref: "#/components/schemas/VirtualConnectionPriceZSide_accessPoint" IpBlockType: type: string description: IP Block type enum: - IPv4 - IPv6 PriceLocation: type: object properties: metroCode: type: string ibx: type: string FabricCloudRouterPackages: type: object properties: code: $ref: "#/components/schemas/FabricCloudRouterCode" description: Cloud Router package VirtualPortType: type: string description: Port type. enum: - XF_PORT VirtualPortLocation: type: object properties: ibx: type: string description: Code assigned to the Equinix International Business Exchange (IBX) data center from which the port is ordered.
The port might be in a different location. description: Geographic data for the port. LinkAggregationGroup: type: object properties: enabled: type: boolean description: Parameter showing whether LAG configuration is mandatory. The default is false. default: false description: Link aggregation group (LAG) preferences and settings. VirtualPortRedundancy: type: object properties: enabled: type: boolean description: Parameter showing whether redundancy is mandatory. The default is false. default: false description: Specifications for redundant connections, which improve service continuity by routing traffic to secondary ports when primary ports are unavailable.
Redundancy increases resilience and boosts site reliability scores. ConnectivitySource: type: object properties: type: $ref: "#/components/schemas/ConnectivitySourceType" description: Physical or virtual port that houses the connection. VirtualPortServiceType: type: string description: Port service type. The default is managed-service provider (MSP). default: MSP enum: - MSP - EPL VirtualPortConfiguration: type: object properties: buyout: type: boolean description: Buyout (true) or standard (false) configuration of the port at this access point.
Buyout ports offer free, unlimited connections. Standard ports do not. The default is false. default: false description: Port configuration. TimeServicePriceConnection: type: object properties: aSide: $ref: "#/components/schemas/TimeServicePriceConnectionASide" description: Time Service Price Connection configuration AccessPointSelector: type: object properties: type: type: string description: Type of Access point enum: - COLO - VD - NETWORK hideAssetInfo: type: boolean deprecated: true port: $ref: "#/components/schemas/SimplifiedMetadataEntity" linkProtocol: $ref: "#/components/schemas/SimplifiedLinkProtocol" virtualDevice: $ref: "#/components/schemas/SimplifiedVirtualDevice" interface: $ref: "#/components/schemas/VirtualDeviceInterface" network: $ref: "#/components/schemas/SimplifiedTokenNetwork" description: List of criteria for selecting network access points with optimal efficiency, security, compatibility, and availability. OutputStructuredPingResponseItem: type: object properties: bytes: type: integer example: 100 ip: type: string example: 8.8.8.8 icmpSeq: type: integer example: 0 ttl: type: integer example: 117 time: type: number format: float example: 9.839 LinkProtocolType: type: string description: Type of Link Protocol enum: - UNTAGGED - DOT1Q - QINQ - EVPN_VXLAN - VXLAN VirtualConnectionPriceAccessPointType: type: string description: Virtual Connection access point type enum: - VD - SP - COLO - CLOUD_ROUTER - CHAINGROUP - NETWORK - METAL_NETWORK VirtualConnectionBridgePackageCode: type: string description: Virtual Connection bridge package code enum: - REGIONAL - GLOBAL FabricCloudRouterCode: type: string description: Cloud Router code enum: - LAB - ADVANCED - STANDARD - PREMIUM ConnectivitySourceType: type: string description: Type of connectivity. COLO, colocation; BMMR, building meet-me room. The default is COLO.
A building meet-me room (BMMR) is a room within the same building where an Equinix IBX customer can connect with a non-Equinix IBX customer. default: COLO enum: - COLO - BMMR - REMOTE TimeServicePriceConnectionASide: type: object properties: accessPoint: $ref: "#/components/schemas/TimeServicePriceConnectionAccessPoint" description: Time Service Price Connection ASide configuration SimplifiedMetadataEntity: type: object properties: href: type: string description: url to entity format: uri uuid: type: string description: Equinix assigned Identifier format: uuid type: type: string description: Type of Port cvpId: type: integer description: Customer virtual port Id bandwidth: type: number description: Port Bandwidth portName: type: string description: Port Name encapsulationProtocolType: type: string description: Port Encapsulation accountName: type: string description: Account Name priority: type: string description: Port Priority location: $ref: "#/components/schemas/SimplifiedLocation" description: Configuration details for port used at the access point. SimplifiedVirtualDevice: type: object properties: href: type: string description: url to entity format: uri uuid: type: string description: Network Edge assigned Virtual Device Identifier format: uuid type: type: string description: Type of Virtual Device enum: - EDGE name: type: string description: Customer-assigned Virtual Device name cluster: type: string description: Virtual Device Cluster Information VirtualDeviceInterface: type: object properties: type: type: string description: Type of interface enum: - NETWORK id: type: integer description: Network Edge assigned identifier uuid: type: string description: Interface identifier format: uuid description: Virtual Device Interface Information SimplifiedTokenNetwork: type: object properties: href: type: string description: url to entity format: uri uuid: type: string description: Network Identifier format: uuid type: type: string description: Type of Network enum: - EVPLAN - EPLAN - IPWAN name: type: string description: Network Name scope: type: string description: scope of Network enum: - LOCAL - REGIONAL - GLOBAL location: $ref: "#/components/schemas/SimplifiedLocation" TimeServicePriceConnectionAccessPoint: type: object properties: location: $ref: "#/components/schemas/PriceLocation" description: Time Service Price Connection Access Point configuration PriceError_additionalInfo: type: object properties: property: type: string reason: type: string RouteFiltersData_project: required: - projectId type: object properties: projectId: type: string description: Subscriber-assigned project ID example: 44f4c4f8-2f39-494e-838c-d8e640591be5 href: type: string description: Project URI format: uri example: https://api.equinix.com/resourceManager/v1/projects/567 RouteFiltersSearchBase_filter: type: object properties: and: type: array items: $ref: "#/components/schemas/RouteFiltersSearchFilterItem" RouteAggregationsData_project: required: - projectId type: object properties: projectId: type: string description: Subscriber-assigned project ID example: 44f4c4f8-2f39-494e-838c-d8e640591be5 href: type: string description: Project URI format: uri RouteAggregationsSearchBase_filter: type: object properties: and: type: array items: $ref: "#/components/schemas/RouteAggregationsSearchFilterItem" ValidateRequest_filter_and: properties: property: type: string description: Path to property operator: type: string description: Type of operation values: type: array description: Values for the given property items: type: string ValidateRequest_filter: type: object properties: and: type: array items: $ref: "#/components/schemas/ValidateRequest_filter_and" description: Filters ConnectionRouteTableEntry_connection: type: object properties: uuid: type: string example: 81331c52-04c0-4656-a4a7-18c52669348f name: type: string example: connection_1 PortOrder_purchaseOrder: type: object properties: number: type: string description: purchase order number amount: type: string description: purchase order amount startDate: type: string format: datetime endDate: type: string format: datetime attachmentId: type: string format: uuid selectionType: type: string deprecated: true enum: - EXEMPTION - EXISTING - NEW - BLANKET type: type: string enum: - EXEMPTION - EXISTING - NEW - BLANKET description: purchase order PortOrder_signature_delegate: type: object properties: firstName: type: string description: name of delegate lastName: type: string description: last Name of delegate email: type: string description: email of delegate description: delegate oder details PortOrder_signature: type: object properties: signatory: type: string description: Port signature Type enum: - DELEGATE - SELF - ACCOUNT_SUPPORT delegate: $ref: "#/components/schemas/PortOrder_signature_delegate" description: Port signature Type VirtualConnectionPriceASide_accessPoint_port_settings: type: object properties: buyout: type: boolean default: false VirtualConnectionPriceASide_accessPoint_port: type: object properties: settings: $ref: "#/components/schemas/VirtualConnectionPriceASide_accessPoint_port_settings" VirtualConnectionPriceASide_accessPoint: type: object properties: uuid: type: string format: uuid type: $ref: "#/components/schemas/VirtualConnectionPriceAccessPointType" location: $ref: "#/components/schemas/PriceLocation" port: $ref: "#/components/schemas/VirtualConnectionPriceASide_accessPoint_port" VirtualConnectionPriceZSide_accessPoint_profile: type: object properties: uuid: type: string format: uuid VirtualConnectionPriceZSide_accessPoint_bridge_package: type: object properties: code: $ref: "#/components/schemas/VirtualConnectionBridgePackageCode" VirtualConnectionPriceZSide_accessPoint_bridge: type: object properties: package: $ref: "#/components/schemas/VirtualConnectionPriceZSide_accessPoint_bridge_package" VirtualConnectionPriceZSide_accessPoint: type: object properties: uuid: type: string format: uuid type: $ref: "#/components/schemas/VirtualConnectionPriceAccessPointType" location: $ref: "#/components/schemas/PriceLocation" port: $ref: "#/components/schemas/VirtualConnectionPriceASide_accessPoint_port" profile: $ref: "#/components/schemas/VirtualConnectionPriceZSide_accessPoint_profile" bridge: $ref: "#/components/schemas/VirtualConnectionPriceZSide_accessPoint_bridge" examples: "400": value: - errorCode: EQ-3142102 errorMessage: Connection has duplicate buyer-side VLAN ID for port or the same VLAN ID is in the process of being deleted and should be freed up soon correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec additionalInfo: - property: /aSide/accessPoint/linkProtocol - errorCode: EQ-3142535 errorMessage: The connection bandwidth provided in the connection request exceeds the bandwidth Limit on ServiceToken details: Please enter bandwidth less than the Speed limit on ServiceToken correlationId: test additionalInfo: - property: /aSide/serviceToken/uuid - errorCode: EQ-3142536 errorMessage: Remote connection cannot be created with the provided ServiceToken details: Only local Connection can be created using this ServiceToken correlationId: test additionalInfo: - property: /zSide/accessPoint/port/uuid - errorCode: EQ-3142701 errorMessage: The connection bandwidth provided in the connection request exceeds the bandwidth Limit on ServiceToken details: not an authorized user correlationId: test - errorCode: EQ-3142501 errorMessage: Invalid input correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 additionalInfo: - property: aSide/accessPoint/port/uuid - errorCode: EQ-3142509 errorMessage: Connection already deleted correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec additionalInfo: - property: uuid - errorCode: EQ-3142510 errorMessage: Connection is in transient state correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 additionalInfo: - property: uuid - errorCode: EQ-3142221 errorMessage: The primary and secondary token provided have different bandwidth tiers. Please use two tokens that support the same bandwidth tiers correlationId: test additionalInfo: - property: /zSide/serviceToken/uuid - errorCode: EQ-3142222 errorMessage: The primary and secondary tokens have different encapsulation types (Dot1Q or QinQ). Please use two tokens that support the same encapsulation type correlationId: test additionalInfo: - property: /zSide/serviceToken/uuid - errorCode: EQ-3142223 errorMessage: The primary and secondary tokens belong to different projects. Please use two tokens that belong to the same project correlationId: test additionalInfo: - property: /zSide/serviceToken/uuid - errorCode: EQ-3142224 errorMessage: The primary and secondary ports have different port speeds (bandwidth). Please use two tokens that support the same port speed correlationId: test additionalInfo: - property: /zSide/serviceToken/uuid - errorCode: EQ-3142225 errorMessage: The primary and secondary tokens provided are the same. Please provide a different token correlationId: test additionalInfo: - property: /zSide/serviceToken/uuid - errorCode: EQ-3142514 errorMessage: Redundancy group is required correlationId: test additionalInfo: - property: /redundancy/group - errorCode: EQ-3142515 errorMessage: Redundancy priority is required correlationId: test additionalInfo: - property: /redundancy/priority - errorCode: EQ-3142516 errorMessage: Invalid redundancy group correlationId: test additionalInfo: - property: /redundancy/group - errorCode: EQ-3142517 errorMessage: Invalid redundancy priority correlationId: test additionalInfo: - property: /redundancy/priority - errorCode: EQ-3142303 errorMessage: Only Primary connection allowed for this CSP correlationId: test additionalInfo: - property: /redundancy/priority - errorCode: EQ-3142320 errorMessage: For redundant connection, Service Profile should be the same correlationId: test additionalInfo: - property: /zSide/accessPoint/profile/uuid - errorCode: EQ-3142021 errorMessage: For redundant connection, Fabric Cloud Router should be the same correlationId: test additionalInfo: - property: /aSide/accessPoint/router/uuid - errorCode: EQ-3142012 errorMessage: Fabric Cloud Router is not in PROVISIONED state correlationId: test additionalInfo: - property: /aSide/accessPoint/router/uuid - errorCode: EQ-3142301 errorMessage: Given profile does not exist correlationId: test additionalInfo: - property: /zSide/accessPoint/profile/uuid - errorCode: EQ-3142302 errorMessage: Service provider does not exist in required zSide metro correlationId: test additionalInfo: - property: /zSide/accessPoint/location/metroCode - errorCode: EQ-3142013 errorMessage: Invalid metro for Cloud Router connection correlationId: test additionalInfo: - property: /aSide/accessPoint/router/uuid - errorCode: EQ-3142304 errorMessage: Private connections are not allowed on public profiles correlationId: test additionalInfo: - property: visibility - errorCode: EQ-3142306 errorMessage: Requested bandwidth is not supported by service profile correlationId: test additionalInfo: - property: /bandwidth - errorCode: EQ-3142308 errorMessage: Authentication key is required correlationId: test additionalInfo: - property: /zSide/accessPoint/authenticationKey "401": value: - errorCode: EQ-3000039 errorMessage: User not found in request or invalid. correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 "403": value: - errorCode: EQ-3040047 errorMessage: Operation not allowed correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Operation not allowed for current user "404": value: - errorCode: EQ-3040020 errorMessage: uuid not found correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: uuid not found "405": value: - errorCode: EQ-3142569 errorMessage: Method not supported, Please check the URL passed details: Method:PATCH correlationId: f48687b0-d088-46d1-b06c-00c0688fbca9 "415": value: - errorCode: EQ-3040016 errorMessage: Unsupported media type, please check the request's Content-Type or Content-Encoding correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec additionalInfo: - property: contentType reason: The payload format is in an unsupported format "500": value: - errorCode: EQ-3040030 errorMessage: Internal Server Error correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Internal Server Error get-cloud-events-by-asset-id: value: pagination: offset: 20 limit: 10 total: 3 next: null previous: null data: - specversion: "1.0" source: https://api.equinix.com/fabric/v4/events id: 66c62c1a-f186-4fbd-9792-71a60705518f time: 2025-03-20T13:13:12Z type: equinix.fabric.connection.bgpipv4_session_status.connect subject: /fabric/v4/connections/dab9fc84-cc95-4cb4-abe3-ca39361285a9/routingProtocol/e92cdf09-59eb-4131-ade4-49a87dc816dc dataschema: https://equinix.github.io/equinix-cloudevents/jsonschema/equinix/fabric/v1/ChangeEvent.json datacontenttype: application/json severitynumber: 5 severitytext: INFO equinixproject: dadd3ab6-c0af-430c-8216-43d44f08c1c5 authtype: system authid: equinix data: message: Neighbor 100.100.100.102 address session state changed to Connect auth: type: system id: equinix - specversion: "1.0" source: https://api.equinix.com/fabric/v4/cloudevents id: 66c62c1a-f186-4fbd-9792-71a60705518f type: equinix.fabric.connection.state.provisioning subject: /fabric/v4/connections/dab9fc84-cc95-4cb4-abe3-ca39361285a9 time: 2025-03-20T13:13:12Z dataschema: https://equinix.github.io/equinix-cloudevents/jsonschema/equinix/fabric/v1/ChangeEvent.json datacontenttype: application/json severitynumber: 9 severitytext: INFO equinixproject: dadd3ab6-c0af-430c-8216-43d44f08c1c5 authtype: user authid: 123456 data: message: Connection named TEST-CONNECTION state changed to provisioning resource: href: https://api.corp.equinix.com/fabric/v4/connections/dab9fc84-cc95-4cb4-abe3-ca39361285a9 uuid: dab9fc84-cc95-4cb4-abe3-ca39361285a9 type: IP_VC name: TEST-CONNECTION state: PROVISIONING auth: type: user id: 123456 name: test user email: testuser@test.com - specversion: "1.0" source: https://api.equinix.com/fabric/v4/cloudevents id: 66c62c1a-f186-4fbd-9792-71a60705518f type: equinix.fabric.connection.state.provisioned subject: /fabric/v4/connections/dab9fc84-cc95-4cb4-abe3-ca39361285a9 time: 2025-03-20T13:13:12Z dataschema: https://equinix.github.io/equinix-cloudevents/jsonschema/equinix/fabric/v1/ChangeEvent.json datacontenttype: application/json severitynumber: 9 severitytext: INFO equinixproject: dadd3ab6-c0af-430c-8216-43d44f08c1c5 authtype: system authid: equinix data: message: Connection named TEST-CONNECTION state changed to provisioned resource: href: https://api.corp.equinix.com/fabric/v4/connections/dab9fc84-cc95-4cb4-abe3-ca39361285a9 uuid: dab9fc84-cc95-4cb4-abe3-ca39361285a9 type: IP_VC name: TEST-CONNECTION state: PROVISIONED auth: type: system id: equinix get-cloud-event: value: specversion: "1.0" source: https://api.equinix.com/fabric/v4/cloudevents id: 66c62c1a-f186-4fbd-9792-71a60705518f type: equinix.fabric.connection.state.provisioning subject: /fabric/v4/connections/dab9fc84-cc95-4cb4-abe3-ca39361285a9 time: 2025-03-20T13:13:12Z dataschema: https://equinix.github.io/equinix-cloudevents/jsonschema/equinix/fabric/v1/ChangeEvent.json datacontenttype: application/json severitynumber: 9 severitytext: INFO equinixproject: dadd3ab6-c0af-430c-8216-43d44f08c1c5 authtype: user authid: 123456 data: message: Connection named TEST-CONNECTION state changed to provisioning resource: href: https://api.corp.equinix.com/fabric/v4/connections/dab9fc84-cc95-4cb4-abe3-ca39361285a9 uuid: dab9fc84-cc95-4cb4-abe3-ca39361285a9 type: IP_VC name: TEST-CONNECTION state: PROVISIONING auth: type: user id: 123456 name: test user email: testuser@test.com search-cloud-events: value: filter: and: - property: /type operator: IN values: - equinix.fabric.port.status.* - property: /subject operator: IN values: - /fabric/v4/ports/8ac8ecfe-c7cb-4def-9f77-5ce93c19d83d* - /fabric/v4/ports/c8bba3be-5132-4669-bb47-7f1a8811359b* - property: /time operator: ">" values: - 2018-04-05T17:31:00.000Z pagination: offset: 0 limit: 20 COLO2COLOwithDot1q-Dot1q: value: type: EVPL_VC name: My-Layer2-Connection-3 bandwidth: 1000 redundancy: priority: PRIMARY aSide: accessPoint: type: COLO port: uuid: a8ba52de-faae-43b5-b0b1-6904d37ee063 linkProtocol: type: DOT1Q vlanTag: 1001 order: purchaseOrderNumber: po1234 zSide: accessPoint: type: COLO port: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d linkProtocol: type: DOT1Q vlanTag: 1001 notifications: - type: ALL emails: - test@test.com COLO2COLOwithDot1qAndTerms-Dot1q: value: type: EVPL_VC name: My-Layer2-Connection-3 bandwidth: 1000 redundancy: priority: PRIMARY aSide: accessPoint: type: COLO port: uuid: a8ba52de-faae-43b5-b0b1-6904d37ee063 location: metroCode: SV linkProtocol: type: DOT1Q vlanTag: 1001 order: purchaseOrderNumber: po1234 termLength: 24 zSide: accessPoint: type: COLO port: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d location: metroCode: DC linkProtocol: type: DOT1Q vlanTag: 1001 notifications: - type: ALL emails: - test@test.com COLO2COLOwithDot1q-Dot1q-CRH: value: type: EVPL_VC name: My-Layer2-Connection-3 bandwidth: 1000 redundancy: priority: PRIMARY aSide: accessPoint: type: COLO port: uuid: a867f685-41b0-1b07-6de0-320a5c00abdd linkProtocol: type: DOT1Q vlanTag: 1001 order: purchaseOrderNumber: po1234 zSide: accessPoint: type: COLO port: uuid: b067f685-49b0-1a09-6fe0-360a5d00afdg linkProtocol: type: DOT1Q vlanTag: 1001 project: projectId: 30ad25e2-53dc-11ed-bdc3-0242ac120002 notifications: - type: ALL emails: - test@test.com COLO2COLOwithDot1Q-QinQ: value: type: EVPL_VC name: My-Layer2-Connection-3 bandwidth: 1000 redundancy: priority: PRIMARY aSide: accessPoint: type: COLO port: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d linkProtocol: type: DOT1Q vlanTag: 1001 order: purchaseOrderNumber: po1234 zSide: accessPoint: type: COLO port: uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c linkProtocol: type: QINQ vlanSTag: 1001 vlanCTag: 1002 notifications: - type: ALL emails: - test@test.com COLO2COLOwithQinq-Qinq: value: type: EVPL_VC name: My-Layer2-Connection-3 bandwidth: 1000 redundancy: priority: PRIMARY aSide: accessPoint: type: COLO port: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d linkProtocol: type: QINQ vlanSTag: 1001 order: purchaseOrderNumber: po1234 zSide: accessPoint: type: COLO port: uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c linkProtocol: type: QINQ vlanSTag: 1001 notifications: - type: ALL emails: - test@test.com COLO2COLOwithQinq-Dot1q: value: type: EVPL_VC name: My-Layer2-Connection-3 bandwidth: 1000 redundancy: priority: PRIMARY aSide: accessPoint: type: COLO port: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d linkProtocol: type: QINQ vlanSTag: 1001 vlanCTag: 1125 order: purchaseOrderNumber: po1234 zSide: accessPoint: type: COLO port: uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c linkProtocol: type: DOT1Q vlanTag: 1001 notifications: - type: ALL emails: - test@test.com COLO2COLO-AsReseller: value: type: EVPL_VC name: Conn-1 order: purchaseOrderNumber: 1-129105284100 bandwidth: 100 aSide: accessPoint: type: COLO port: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d linkProtocol: type: DOT1Q vlanTag: 1001 zSide: accessPoint: type: COLO port: uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 linkProtocol: type: QINQ vlanSTag: 1002 vlanCTag: 1001 notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com COLO2COLO-EPL: value: type: EPL_VC name: Conn-1 order: purchaseOrderNumber: 1-129105284100 bandwidth: 100 aSide: accessPoint: type: COLO port: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d zSide: accessPoint: type: COLO port: uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com COLO2COLO-EPL-Terms: value: type: EPL_VC name: Conn-1 order: purchaseOrderNumber: 1-129105284100 termLength: 12 bandwidth: 100 aSide: accessPoint: type: COLO port: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d location: metroCode: SV zSide: accessPoint: type: COLO port: uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 location: metroCode: DC notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com COLO2COLO-AccessEpl: value: type: ACCESS_EPL_VC name: Conn-1 order: purchaseOrderNumber: 1-129105284100 bandwidth: 100 aSide: accessPoint: type: COLO port: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d linkProtocol: type: QINQ vlanSTag: 1234 zSide: accessPoint: type: COLO port: uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com COLO2SPwithDot1q: value: type: EVPL_VC name: My-Layer2-Connection-3 bandwidth: 1000 redundancy: priority: PRIMARY aSide: accessPoint: type: COLO port: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d linkProtocol: type: DOT1Q vlanTag: 1001 order: purchaseOrderNumber: po1234 zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c location: metroCode: DC notifications: - type: ALL emails: - test@test.com COLO2AlibabaSPwithDot1q: value: type: EVPL_VC name: My-Layer2-Connection-3 bandwidth: 1000 redundancy: priority: PRIMARY aSide: accessPoint: type: COLO port: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d linkProtocol: type: DOT1Q vlanTag: 1001 order: purchaseOrderNumber: po1234 zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c location: metroCode: SV sellerRegion: San Jose 2 authenticationKey: xxx-xxx-xxx notifications: - type: ALL emails: - test@test.com COLO2AWSSPwithDot1q-Primary: value: type: EVPL_VC name: Primary-Aws bandwidth: 1000 redundancy: priority: PRIMARY aSide: accessPoint: type: COLO port: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d linkProtocol: type: DOT1Q vlanTag: 1001 order: purchaseOrderNumber: po1234 zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c location: metroCode: DC sellerRegion: us-east-1 authenticationKey: xxx-xxx-xxx notifications: - type: ALL emails: - test@test.com COLO2AzureSPwithDot1q-Primary: value: type: EVPL_VC name: Primary-Azure bandwidth: 1000 redundancy: priority: PRIMARY aSide: accessPoint: type: COLO port: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d linkProtocol: type: DOT1Q vlanTag: 1001 order: purchaseOrderNumber: po1234 zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c location: metroCode: DC linkProtocol: type: QINQ vlanCTag: 1234 peeringType: MICROSOFT authenticationKey: xxx-xxx-xxx notifications: - type: ALL emails: - test@test.com COLO2AzureSPwithQinq-Secondary: value: type: EVPL_VC name: Secondary-Azure bandwidth: 1000 redundancy: group: e04db764-f865-470b-8394-d2efdd651577 priority: SECONDARY aSide: accessPoint: type: COLO port: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d linkProtocol: type: QINQ vlanSTag: 1001 vlanCTag: 1002 order: purchaseOrderNumber: po1234 zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c location: metroCode: DC authenticationKey: xxx-xxx-xxx notifications: - type: ALL emails: - test@test.com COLO2GoogleSPwithDot1q: value: type: EVPL_VC name: My-Layer2-Connection-3 bandwidth: 50 redundancy: priority: PRIMARY aSide: accessPoint: type: COLO port: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d linkProtocol: type: DOT1Q vlanTag: 1001 order: purchaseOrderNumber: po1234 zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c location: metroCode: DC authenticationKey: xx-xxx-xx-xxxxx/us-west1/1 sellerRegion: us-west1 project: projectId: 16799d66ef43 notifications: - type: ALL emails: - fabric@test.com COLO2IBM_1: value: type: EVPL_VC name: My-Layer2-Connection-3 bandwidth: 1000 redundancy: priority: PRIMARY aSide: accessPoint: type: COLO port: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d linkProtocol: type: DOT1Q vlanTag: 1001 order: purchaseOrderNumber: po1234 zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c location: metroCode: DC authenticationKey: xxx-xxx-xxx sellerRegion: San Jose 2 notifications: - type: ALL emails: - test@test.com additionalInfo: - key: ASN value: 1234 - key: Global value: false COLO2IBM_2: value: type: EVPL_VC name: My-Layer2-Connection-3 bandwidth: 1000 redundancy: priority: PRIMARY aSide: accessPoint: type: COLO port: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d linkProtocol: type: DOT1Q vlanTag: 1001 order: purchaseOrderNumber: po1234 zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c location: metroCode: DC authenticationKey: xxx-xxx-xxx sellerRegion: San Jose 2 notifications: - type: ALL emails: - test@test.com additionalInfo: - key: ASN value: 1234 - key: Global value: false - key: BGP_IBM_CIDR value: 172.16.0.18/30 - key: BGP_CER_CIDR value: 172.16.0.19/30 COLO2OracleSPwithDot1q: value: type: EVPL_VC name: My-Layer2-Connection-3 bandwidth: 1000 redundancy: priority: PRIMARY aSide: accessPoint: type: COLO port: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d linkProtocol: type: DOT1Q vlanTag: 1001 order: purchaseOrderNumber: po1234 zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c location: metroCode: DC sellerRegion: us-ashburn-1 authenticationKey: xxx-xxx-xxx notifications: - type: ALL emails: - test@test.com COLO2ServiceToken: value: type: EVPL_VC name: Conn-1 order: purchaseOrderNumber: 1-129105284100 bandwidth: 100 redundancy: group: m167f685-41b0-1b07-6de0-320a5c00abeu priority: SECONDARY aSide: accessPoint: type: COLO port: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d linkProtocol: type: DOT1Q vlanTag: 1001 zSide: serviceToken: uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com COLO2NETWORKwithDot1q: value: type: EVPLAN_VC name: colo2network-evplan-vc bandwidth: 50 aSide: accessPoint: type: COLO port: uuid: 9127bb72-5f4f-4517-be74-3af7ce612687 linkProtocol: type: DOT1Q vlanTag: 300 zSide: accessPoint: type: NETWORK network: uuid: 25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 order: purchaseOrderNumber: 1-129105284100 project: projectId: ae708bbb-d669-406a-845a-99b39ff65fd0 notifications: - type: ALL emails: - fabric@equinix.com COLO2NETWORKwithDot1qAndTerms: value: type: EVPLAN_VC name: colo2network-evplan-vc bandwidth: 50 aSide: accessPoint: type: COLO port: uuid: 9127bb72-5f4f-4517-be74-3af7ce612687 linkProtocol: type: DOT1Q vlanTag: 300 zSide: accessPoint: type: NETWORK network: uuid: 25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 order: purchaseOrderNumber: 1-129105284100 termLength: 24 project: projectId: ae708bbb-d669-406a-845a-99b39ff65fd0 notifications: - type: ALL emails: - fabric@equinix.com COLO2NETWORKwithEPL: value: type: EPLAN_VC name: colo2network-eplan-vc bandwidth: 50 aSide: accessPoint: type: COLO port: uuid: 9127bb72-5f4f-4517-be74-3af7ce612687 zSide: accessPoint: type: NETWORK network: uuid: 25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 order: purchaseOrderNumber: 1-129105284100 project: projectId: ae708bbb-d669-406a-845a-99b39ff65fd0 notifications: - type: ALL emails: - fabric@equinix.com COLO2NETWORKwithEPLAndTerms: value: type: EPLAN_VC name: colo2network-eplan-vc bandwidth: 50 aSide: accessPoint: type: COLO port: uuid: 9127bb72-5f4f-4517-be74-3af7ce612687 zSide: accessPoint: type: NETWORK network: uuid: 25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 order: purchaseOrderNumber: 1-129105284100 termLength: 12 project: projectId: ae708bbb-d669-406a-845a-99b39ff65fd0 notifications: - type: ALL emails: - fabric@equinix.com Vd2NETWORK: value: type: EVPLAN_VC name: MY-EVPLAN-CONNECTION-1 bandwidth: 100 aSide: accessPoint: type: VD virtualDevice: type: EDGE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 interface: type: NETWORK id: 45645 zSide: accessPoint: type: NETWORK network: uuid: 25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 order: purchaseOrderNumber: 1-129105284100 project: projectId: ae708bbb-d669-406a-845a-99b39ff65fd0 notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com Vd2AwsSP: value: type: EVPL_VC name: vd2aws-connection-1 bandwidth: 50 redundancy: priority: PRIMARY aSide: accessPoint: type: VD virtualDevice: type: EDGE uuid: e16136fd-05ef-49dd-ab98-9f8e619619e9 zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 69ee618d-be52-468d-bc99-00566f2dd2b9 location: metroCode: SV sellerRegion: us-west-1 authenticationKey: xxxx-xxx-xxx project: projectId: 16799d66-ef43 order: purchaseOrderNumber: 1-1234567890 notifications: - type: ALL emails: - fabric@equinix.com Vd2AzureSP: value: type: EVPL_VC name: vd2azure-connection-1 bandwidth: 100 redundancy: priority: PRIMARY aSide: accessPoint: type: VD virtualDevice: type: EDGE uuid: e16136fd-05ef-49dd-ab98-9f8e619619e9 zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: a1390b22-bbe0-4e93-ad37-85beef9d254d location: metroCode: SV authenticationKey: xxxx-xxx-xxxx peeringType: MICROSOFT project: projectId: 16799d66-ef43 order: purchaseOrderNumber: 1-1234567890 notifications: - type: ALL emails: - fabric@equinix.com Vd2OracleSP: value: type: EVPL_VC name: vd2oracle-connection-1 bandwidth: 1000 aSide: accessPoint: type: VD virtualDevice: type: EDGE uuid: e16136fd-05ef-49dd-ab98-9f8e619619e9 zSide: accessPoint: type: SP profile: uuid: 60ef0382-cdaa-44e7-bd36-b803731816b8 location: metroCode: DC authenticationKey: ocid1.virtualcircuit.oc1 sellerRegion: us-ashburn-1 project: projectId: 16799d66-ef43 order: purchaseOrderNumber: 1-129105284100 notifications: - type: ALL emails: - fabric@equinix.com Vd2Ibm_1: value: type: EVPL_VC name: vd2ibm10-connection-1 bandwidth: 50 aSide: accessPoint: type: VD virtualDevice: type: EDGE uuid: e16136fd-05ef-49dd-ab98-9f8e619619e9 zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 45b446fa-d3b6-417a-b871-a5ee0efdc459 location: metroCode: DC authenticationKey: xxxx-xxx-xxx sellerRegion: Washington 2 additionalInfo: - key: ASN value: 12345 - key: Global value: false project: projectId: 16799d66-ef43 order: purchaseOrderNumber: 1-129105284100 notifications: - type: ALL emails: - fabric@equinix.com Vd2Ibm_2: value: type: EVPL_VC name: vd2ibm20-connection-1 bandwidth: 50 aSide: accessPoint: type: VD virtualDevice: type: EDGE uuid: e16136fd-05ef-49dd-ab98-9f8e619619e9 zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: e092ed47-63d2-4f4a-87a0-82e3b08eefe5 location: metroCode: SV authenticationKey: xxxx-xxx-xxx sellerRegion: San Jose 2 additionalInfo: - key: ASN value: 12345 - key: BGP_CER_CIDR value: 172.16.0.17/30 - key: BGP_IBM_CIDR value: 172.16.0.18/30 - key: Global value: false project: projectId: 16799d66-ef43 order: purchaseOrderNumber: 1-129105284100 notifications: - type: ALL emails: - fabric@equinix.com Vd2AlibabaSP: value: type: EVPL_VC name: vd2alibaba-connection-1 bandwidth: 50 aSide: accessPoint: type: VD virtualDevice: type: EDGE uuid: e16136fd-05ef-49dd-ab98-9f8e619619e9 zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 4c4b8edf-873b-4c6c-805a-edb2c335bd6c location: metroCode: SV authenticationKey: xxxx-xx-xxxx sellerRegion: us-west-1 notifications: - type: ALL emails: - fabric@equinix.com project: projectId: 16799d66-ef43 Vd2GoogleSP: value: type: EVPL_VC name: vd2googleSp-connection-1 bandwidth: 50 redundancy: priority: PRIMARY aSide: accessPoint: type: VD virtualDevice: type: EDGE uuid: e99ec19c-0939-4c47-bfc1-ff94f99ccc75 zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: bd4570e2-d792-4a00-87f5-3bde040cdcd7 location: metroCode: SV sellerRegion: us-west2 authenticationKey: xxxx-xxxx/us-west2/1 project: projectId: 16799d66-ef43-445c-ba29-d17522d8a137 order: purchaseOrderNumber: 1-1234567890 notifications: - type: ALL emails: - fabric@equinx.com Vd2Sp-Primary: value: type: EVPL_VC bandwidth: 50 name: Network Device to SP redundancy: priority: PRIMARY aSide: accessPoint: type: VD virtualDevice: type: EDGE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 interface: type: NETWORK id: 45645 zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 95542b34-cf1c-41aa-89f7-590946f9df53 authenticationKey: xx-xx-xx sellerRegion: us-west-1 order: purchaseOrderNumber: 1-323292 notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com Vd2Sp-Secondary: value: type: EVPL_VC bandwidth: 50 name: Network Device to SP redundancy: group: 777ca05d-4ae7-4ee9-9456-3ca49500428c priority: SECONDARY aSide: accessPoint: type: VD virtualDevice: type: EDGE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 interface: type: NETWORK id: 45645 zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 95542b34-cf1c-41aa-89f7-590946f9df53 authenticationKey: xx-xx-xx sellerRegion: us-west-1 order: purchaseOrderNumber: 1-323292 notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com Vd2Colo: value: type: EVPL_VC bandwidth: 1000 name: vd to COLO aSide: accessPoint: type: VD virtualDevice: type: EDGE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 interface: type: NETWORK id: 45645 zSide: accessPoint: type: COLO port: uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 linkProtocol: type: DOT1Q vlanTag: 300 order: purchaseOrderNumber: 1-129105284100 notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com Vd2ColoVlanTag: value: type: EVPL_VC bandwidth: 1000 name: vd to COLO aSide: accessPoint: type: VD virtualDevice: type: EDGE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 interface: type: NETWORK id: 45645 zSide: accessPoint: type: COLO port: uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 linkProtocol: type: DOT1Q vlanTagMin: 300 vlanTagMax: 1099 order: purchaseOrderNumber: 1-129105284100 notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com Vd2Colo-VlanCTag: value: type: EVPL_VC bandwidth: 1000 name: vd to COLO aSide: accessPoint: type: VD virtualDevice: type: EDGE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 interface: type: NETWORK id: 45645 zSide: accessPoint: type: COLO port: uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 linkProtocol: type: QINQ vlanCTag: 300 vlanSTag: 301 order: purchaseOrderNumber: 1-129105284100 notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com Vd2ColoUntagged: value: type: EVPL_VC bandwidth: 1000 name: vd to SP aSide: accessPoint: type: VD virtualDevice: type: EDGE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 interface: type: NETWORK id: 45645 zSide: accessPoint: type: COLO port: uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 linkProtocol: type: UNTAGGED order: purchaseOrderNumber: 1-129105284100 notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com Vd2ServiceToken: value: type: EVPL_VC name: Primary-Token order: purchaseOrderNumber: 1-129105284100 bandwidth: 100 redundancy: priority: PRIMARY aSide: accessPoint: type: VD virtualDevice: type: EDGE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 interface: type: NETWORK id: 45645 zSide: serviceToken: uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com Fcr2Colo: value: type: IP_VC name: My-FCR-Connection bandwidth: 1000 aSide: accessPoint: type: CLOUD_ROUTER router: uuid: 66a21614-1c4a-11ec-9621-0242ac130002 zSide: accessPoint: type: COLO port: uuid: 7b6481b8-1c4a-11ec-9621-0242ac130002 linkProtocol: type: DOT1Q vlanTag: 1001 order: purchaseOrderNumber: 1-129105284100 project: projectId: "567" notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com Fcr2Sp-Google: value: type: IP_VC name: My-FCR-GCPConnection bandwidth: 1000 aSide: accessPoint: type: CLOUD_ROUTER router: uuid: 66a21614-1c4a-11ec-9621-0242ac130002 zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 authenticationKey: xx-xx-xx sellerRegion: us-west1 location: metroCode: SV order: purchaseOrderNumber: 1-129105284100 project: projectId: "567" notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com Fcr2Sp-Azure: value: type: IP_VC name: My-FCR-AzureConnection bandwidth: 1000 aSide: accessPoint: type: CLOUD_ROUTER router: uuid: 66a21614-1c4a-11ec-9621-0242ac130002 zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 authenticationKey: xx-xx-xx location: metroCode: SV peeringType: PRIVATE order: purchaseOrderNumber: 1-129105284100 project: projectId: "567" notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com Fcr2Sp-Generic: value: type: IP_VC name: My-FCR-GenericConnection bandwidth: 1000 aSide: accessPoint: type: CLOUD_ROUTER router: uuid: 66a21614-1c4a-11ec-9621-0242ac130002 zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 location: metroCode: SV order: purchaseOrderNumber: 1-129105284100 project: projectId: "567" notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com Fcr2Sp-Generic-Redundant-Secondary: value: type: IP_VC name: FCR_to_RedSP_Secondary bandwidth: 50 redundancy: group: a00cef6f-8e35-4794-9ff9-665e084e4e6d priority: SECONDARY aSide: accessPoint: type: CLOUD_ROUTER router: uuid: 66a21614-1c4a-11ec-9621-0242ac130002 zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 location: metroCode: SV order: purchaseOrderNumber: 1-129105284100 project: projectId: "567" notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com Fcr2Sp-Generic-Redundant-Primary: value: type: IP_VC name: FCR_to_RedSP_Primary-Re-add bandwidth: 50 redundancy: group: a00cef6f-8e35-4794-9ff9-665e084e4e6d priority: PRIMARY aSide: accessPoint: type: CLOUD_ROUTER router: uuid: 66a21614-1c4a-11ec-9621-0242ac130002 zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 location: metroCode: SV order: purchaseOrderNumber: 1-129105284100 project: projectId: "567" notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com Fcr2Sp-Aws: value: type: IP_VC name: My-FCR-AWSConnection bandwidth: 100 redundancy: priority: PRIMARY aSide: accessPoint: type: CLOUD_ROUTER router: uuid: 66a21614-1c4a-11ec-9621-0242ac130002 zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 location: metroCode: SV sellerRegion: us-west-1 authenticationKey: xx-xx-xx project: projectId: "567" notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com Fcr2Sp-Oracle: value: type: IP_VC name: My-FCR-OracleConnection bandwidth: 1000 redundancy: priority: PRIMARY aSide: accessPoint: type: CLOUD_ROUTER router: uuid: 66a21614-1c4a-11ec-9621-0242ac130002 zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 location: metroCode: DC sellerRegion: us-ashburn-1 authenticationKey: xx-xx-xx notifications: - type: ALL emails: - test@equinix.com project: projectId: "567" Fcr2Vd: value: type: IP_VC name: My-GW-VDConnection bandwidth: 100 redundancy: priority: PRIMARY aSide: accessPoint: type: CLOUD_ROUTER router: uuid: 66a21614-1c4a-11ec-9621-0242ac130002 zSide: accessPoint: type: VD virtualDevice: type: EDGE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 interface: type: NETWORK id: 45645 project: projectId: "567" notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com Fcr2Vd-Redundant-Secondary: value: type: IP_VC name: My-GW-VDConnection-Secondary bandwidth: 100 redundancy: group: a00cef6f-8e35-4794-9ff9-665e084e4e6d priority: SECONDARY aSide: accessPoint: type: CLOUD_ROUTER router: uuid: 66a21614-1c4a-11ec-9621-0242ac130002 zSide: accessPoint: type: VD virtualDevice: type: EDGE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 interface: type: NETWORK id: 45645 project: projectId: "567" notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com Fcr2IpWan: value: type: IPWAN_VC name: MY-IPWAN-CONNECTION-1 bandwidth: 1000 aSide: accessPoint: type: CLOUD_ROUTER router: uuid: 66a21614-1c4a-11ec-9621-0242ac130002 zSide: accessPoint: type: NETWORK network: uuid: 25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 order: purchaseOrderNumber: 1-129105284100 project: projectId: 123 notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com Fcr2Sp-Aws-marketplaceSubscription: value: type: IP_VC name: My-FCR-AWSConnection bandwidth: 100 redundancy: priority: PRIMARY aSide: accessPoint: type: CLOUD_ROUTER router: uuid: 66a21614-1c4a-11ec-9621-0242ac130002 zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 location: metroCode: SV sellerRegion: us-west-1 authenticationKey: xx-xx-xx project: projectId: ae708bbb-d669-406a-845a-99b39ff65fd0 notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com Fcr2Metal-Network: value: type: IP_VC name: My-FCR-MetalNetwork-Connection bandwidth: 50 redundancy: group: a00cef6f-8e35-4794-9ff9-665e084e4e6d priority: SECONDARY aSide: accessPoint: type: CLOUD_ROUTER router: uuid: 66a21614-1c4a-11ec-9621-0242ac130002 zSide: accessPoint: type: METAL_NETWORK authenticationKey: xxxxxxxxx project: projectId: "567" notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com Fcr2ServiceToken: value: type: IP_VC name: My-FCR-Connection bandwidth: 1000 aSide: accessPoint: type: CLOUD_ROUTER router: uuid: 66a21614-1c4a-11ec-9621-0242ac130002 location: metroCode: SV zSide: serviceToken: uuid: 4cc30499-d472-4edb-9114-1381ed17e356 order: purchaseOrderNumber: 1-129105284100 project: projectId: "567" notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com AsideServiceToken2PortWithDot1q: value: type: EVPL_VC name: Aside-token bandwidth: 1000 redundancy: priority: PRIMARY aSide: serviceToken: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d zSide: accessPoint: type: COLO port: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d location: metroCode: SV linkProtocol: type: DOT1Q vlanTag: 1001 order: purchaseOrderNumber: po1234 notifications: - type: ALL emails: - test@test.com AsideServiceToken2PortWithQinq: value: type: EVPL_VC name: Aside-Token bandwidth: 1000 redundancy: priority: PRIMARY aSide: serviceToken: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d zSide: accessPoint: type: COLO port: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d location: metroCode: SV linkProtocol: type: QINQ vlanSTag: 1001 vlanCTag: 1001 order: purchaseOrderNumber: po1234 notifications: - type: ALL emails: - test@test.com AsideServiceToken2PrivateSP-NE: value: type: EVPL_VC name: Token2PrivateSP-NE bandwidth: 50 redundancy: priority: PRIMARY order: purchaseOrderNumber: po1234 aSide: serviceToken: uuid: 41a9e1ef-18bb-485b-a9b3-99801ac03684 zSide: accessPoint: type: SP profile: uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 location: metroCode: SV notifications: - type: ALL emails: - test@test.com AsideServiceToken2ZsideServiceToken: value: type: EVPL_VC name: Aside to zside token connection bandwidth: 50 redundancy: priority: PRIMARY aSide: serviceToken: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d zSide: serviceToken: uuid: 4f9c5438-90eb-4295-b109-7754119a1e8d order: purchaseOrderNumber: po1234 notifications: - type: ALL emails: - test@test.com Metal2Sp-Aws: value: type: EVPL_VC name: My-Metal-sp-connection bandwidth: "1000" aSide: accessPoint: type: METAL_NETWORK authenticationKey: xxxxxxxxx zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 9127bb72-5f4f-4517-be74-3af7ce612687 authenticationKey: xxxxxxxxx sellerRegion: us-west-1 notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com project: projectId: 567 Metal2Sp-Azure: value: type: EVPL_VC name: Metal2Azure Connection bandwidth: "50" aSide: accessPoint: type: METAL_NETWORK authenticationKey: xxxxxxxxx zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: a1390b22-bbe0-4e93-ad37-85beef9d254d location: metroCode: SV authenticationKey: xxxxxxxxx peeringType: PRIVATE notifications: - type: ALL emails: - eqxfabricamcrh@gmail.com project: projectId: 16799d66-ef43-445c-ba29-d17522d8a137 Metal2Sp-GCP: value: type: EVPL_VC name: Metal2GCP-Connection bandwidth: "50" aSide: accessPoint: type: METAL_NETWORK authenticationKey: xxxxxxxxx zSide: accessPoint: type: SP profile: uuid: 063f4b0f-2d5b-4db7-95da-d9eddfc92602 location: metroCode: SV authenticationKey: xxxxxxxxx sellerRegion: us-west1 notifications: - type: ALL emails: - test@equinix.com project: projectId: "377533000114703" Metal2Sp-Oracle: value: type: EVPL_VC name: Metal2Oracle-Connection bandwidth: "50" aSide: accessPoint: type: METAL_NETWORK authenticationKey: xxxxxxxxx zSide: accessPoint: type: SP profile: uuid: 60ef0382-cdaa-44e7-bd36-b803731816b8 location: metroCode: SV authenticationKey: xxxxxxxxx sellerRegion: us-sanjose-1 notifications: - type: ALL emails: - test@gmail.com project: projectId: 16799d66-ef43-445c-ba29-d17522d8a137 Metal2Sp-IBM: value: type: EVPL_VC name: Metal2IBM-Connection bandwidth: "50" aSide: accessPoint: type: METAL_NETWORK authenticationKey: xxxxxxxxx zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 317dcd1c-83ba-4d7c-994a-3e7ddb875026 location: metroCode: SV authenticationKey: xxxxxxxxx sellerRegion: San Jose 2 additionalInfo: - key: ASN value: 12345 - key: BGP_CER_CIDR value: 172.16.0.17/30 - key: BGP_IBM_CIDR value: 172.16.0.18/30 - key: Global value: false notifications: - type: ALL emails: - test@equinix.com project: projectId: "377533000114703" Metal2Port-Dot1q: value: type: EVPL_VC name: Metal2Port-dot1q bandwidth: "50" aSide: accessPoint: type: METAL_NETWORK authenticationKey: xxxxxxxxx zSide: accessPoint: type: COLO port: uuid: 6c73d02c-87e1-4642-8e18-01eb4b87e243 linkProtocol: type: DOT1Q vlanTag: 128 notifications: - type: ALL emails: - test@equinix.com project: projectId: "377533000114703" Metal2Port-Qinq: value: type: EVPL_VC name: Metal2Port-qinq bandwidth: "50" aSide: accessPoint: type: METAL_NETWORK authenticationKey: xxxxxxxxx zSide: accessPoint: type: COLO port: uuid: 4ff4047c-7217-4b79-9943-c2c4a2f7324d linkProtocol: type: QINQ vlanSTag: 134 vlanCTag: 439 notifications: - type: ALL emails: - test@equinix.com project: projectId: "377533000114703" Metal2ServiceToken: value: type: EVPL_VC name: Metal2ServiceToken bandwidth: "50" aSide: accessPoint: type: METAL_NETWORK authenticationKey: xxxxxxxxx zSide: serviceToken: uuid: bc1383be-579a-4d75-ae19-b0d487bbff90 notifications: - type: ALL emails: - test@equinix.com project: projectId: "377533000114703" Metal2Sp-Generic: value: type: EVPL_VC name: Metal2Generic bandwidth: 1000 redundancy: priority: PRIMARY aSide: accessPoint: type: METAL_NETWORK authenticationKey: xxxxxxxxx zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c location: metroCode: DC notifications: - type: ALL emails: - test@test.com MCNS2Sp-Alibaba: value: type: EVPL_VC name: My-MCNS2Alibaba-Connection bandwidth: 50 aSide: accessPoint: type: VPIC_INTERFACE authenticationKey: xxxx-xxx-xxxx zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 4c4b8edf-873b-4c6c-805a-edb2c335bd6c location: metroCode: DC authenticationKey: xxxx-xxx-xxxx sellerRegion: us-east-1 project: projectId: 16799d66-ef43-445c-ba29-d17522d8a137 notifications: - type: ALL emails: - fabric@gmail.com - fabric1@gmail.com MCNS2Sp-Aws: value: type: EVPL_VC name: My-MCNS2Aws-Connection bandwidth: 50 aSide: accessPoint: type: VPIC_INTERFACE authenticationKey: xxxx-xxx-xxxx zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 9127bb72-5f4f-4517-be74-3af7ce612687 location: metroCode: DC authenticationKey: xxxx-xxx-xxxx sellerRegion: us-east-1 project: projectId: b543e64d-1e13-423a-9d81-4eae7b0e1959 notifications: - type: ALL emails: - fabric@gmail.com - fabric1@gmail.com MCNS2Sp-GCP: value: type: EVPL_VC name: My-MCNS2GCP-Connection bandwidth: 50 aSide: accessPoint: type: VPIC_INTERFACE authenticationKey: xxxx-xxx-xxxx zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: bd4570e2-d792-4a00-87f5-3bde040cdcd7 location: metroCode: DC authenticationKey: xxxx-xxx-xxxx sellerRegion: us-east1 project: projectId: 16799d66-ef43-445c-ba29-d17522d8a137 notifications: - type: ALL emails: - fabric@gmail.com - fabric1@gmail.com MCNS2Sp-IBM2: value: type: EVPL_VC name: My-MCNS2IBM2-Connection bandwidth: 50 aSide: accessPoint: type: VPIC_INTERFACE authenticationKey: xxxx-xxx-xxxx zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: e092ed47-63d2-4f4a-87a0-82e3b08eefe5 location: metroCode: DC authenticationKey: xxxx-xxx-xxxx sellerRegion: Washington 2 additionalInfo: - key: ASN value: 12345 - key: BGP_CER_CIDR value: 172.16.0.17/30 - key: BGP_IBM_CIDR value: 172.16.0.18/30 - key: Global value: false project: projectId: 16799d66-ef43-445c-ba29-d17522d8a137 notifications: - type: ALL emails: - fabric@gmail.com - fabric1@gmail.com MCNS2Sp-Azure: value: type: EVPL_VC name: My-MCNS2Azure-Connection bandwidth: 50 aSide: accessPoint: type: VPIC_INTERFACE authenticationKey: xxxx-xxx-xxxx zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: a1390b22-bbe0-4e93-ad37-85beef9d254d location: metroCode: DC authenticationKey: xxxx-xxx-xxxx peeringType: PRIVATE project: projectId: 16799d66-ef43-445c-ba29-d17522d8a137 notifications: - type: ALL emails: - fabric@gmail.com - fabric1@gmail.com MCNS2Sp-OCI: value: type: EVPL_VC name: My-MCNS2OCI-Connection bandwidth: 50 aSide: accessPoint: type: VPIC_INTERFACE authenticationKey: xxxx-xxx-xxxx zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 60ef0382-cdaa-44e7-bd36-b803731816b8 location: metroCode: DC authenticationKey: xxxx-xxx-xxxx sellerRegion: us-ashburn-1 project: projectId: 16799d66-ef43-445c-ba29-d17522d8a137 notifications: - type: ALL emails: - fabric@gmail.com - fabric1@gmail.com Vd2IAProfile-Request: value: type: IA_VC bandwidth: 50 name: Network Device to IA SP redundancy: priority: PRIMARY aSide: accessPoint: type: VD virtualDevice: type: EDGE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 interface: type: CLOUD id: 4 zSide: accessPoint: type: SP profile: type: IA_PROFILE uuid: 32d81829-0bf8-45d5-84e2-7289a553dbb6 location: metroCode: SV order: purchaseOrderNumber: 1-323292 notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com CreateConnectionDryRunRequest: value: type: EVPL_VC name: My-EVPL-Connection bandwidth: 500 redundancy: priority: PRIMARY aSide: accessPoint: type: COLO port: uuid: 2a4fb415-5a7f-436f-bae6-02f5e403deec linkProtocol: type: DOT1Q vlanTag: 1137 zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 92dc376a-a932-43aa-a6a2-c806dedbd784 location: metroCode: DC project: projectId: a347a370-39b5-427f-c330-7471a9abd9 order: purchaseOrderNumber: 1-129105284100 notifications: - type: ALL emails: - test@test.com CreateConnectionDryRunResponse-Colo2AWS: value: type: EVPL_VC name: Colo to AWS Connection bandwidth: 50 redundancy: priority: PRIMARY aSide: accessPoint: type: COLO port: href: https://api.equinix.com/fabric/v4/ports/2a4fb415-5a7f-436f-bae6-02f5e403deec uuid: 2a4fb415-5a7f-436f-bae6-02f5e403deec linkProtocol: type: DOT1Q vlanTag: 1137 zSide: accessPoint: type: SP profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/20d32a80-0d61-4333-bc03-707b591ae2f5 type: L2_PROFILE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 location: metroHref: https://api.equinix.com/fabric/v4/metros/SV metroCode: SV sellerRegion: us-west-1 authenticationKey: xxx-xxx-xxx project: projectId: a347a370-39b5-427f-c330-7471a9abd9 order: purchaseOrderNumber: 1-129105284100 notifications: - type: ALL emails: - test@test.com CreateConnectionDryRunResponse-Colo2Azure: value: type: EVPL_VC name: Colo to Azure Connection bandwidth: 50 redundancy: priority: PRIMARY aSide: accessPoint: type: COLO port: href: https://api.equinix.com/fabric/v4/ports/2a4fb415-5a7f-436f-bae6-02f5e403deec uuid: 2a4fb415-5a7f-436f-bae6-02f5e403deec linkProtocol: type: DOT1Q vlanTag: 1137 zSide: accessPoint: type: SP profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/20d32a80-0d61-4333-bc03-707b591ae2f5 type: L2_PROFILE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 location: metroHref: https://api.equinix.com/fabric/v4/metros/SV metroCode: SV authenticationKey: xxx-xxx-xxx peeringType: PRIVATE project: projectId: a347a370-39b5-427f-c330-7471a9abd9 order: purchaseOrderNumber: 1-129105284100 notifications: - type: ALL emails: - test@test.com CreateConnectionDryRunResponse-Colo2Google: value: type: EVPL_VC name: Colo to Google Connection bandwidth: 50 redundancy: priority: PRIMARY aSide: accessPoint: type: COLO port: href: https://api.equinix.com/fabric/v4/ports/2a4fb415-5a7f-436f-bae6-02f5e403deec uuid: 2a4fb415-5a7f-436f-bae6-02f5e403deec linkProtocol: type: DOT1Q vlanTag: 1137 zSide: accessPoint: type: SP profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/bd4570e2-d792-4a00-87f5-3bde040cdcd7 type: L2_PROFILE uuid: bd4570e2-d792-4a00-87f5-3bde040cdcd7 location: metroHref: https://api.equinix.com/fabric/v4/metros/SV metroCode: SV sellerRegion: us-west-1 authenticationKey: xxx-xxx-xxx project: projectId: a347a370-39b5-427f-c330-7471a9abd9 order: purchaseOrderNumber: 1-129105284100 notifications: - type: ALL emails: - test@test.com CreateConnectionDryRunResponse-Colo2IBM: value: type: EVPL_VC name: Colo to IBM Connection bandwidth: 50 redundancy: priority: PRIMARY aSide: accessPoint: type: COLO port: href: https://api.equinix.com/fabric/v4/ports/2a4fb415-5a7f-436f-bae6-02f5e403deec uuid: 2a4fb415-5a7f-436f-bae6-02f5e403deec linkProtocol: type: DOT1Q vlanTag: 1137 zSide: accessPoint: type: SP profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c type: L2_PROFILE uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c location: metroHref: https://api.equinix.com/fabric/v4/metros/SV metroCode: SV sellerRegion: us-west-1 authenticationKey: xxx-xxx-xxx additionalInfo: - key: ASN value: 1234 - key: Global value: false project: projectId: a347a370-39b5-427f-c330-7471a9abd9 order: purchaseOrderNumber: 1-129105284100 notifications: - type: ALL emails: - test@test.com CreateConnectionDryRunResponse-Colo2Network-EPLAN_VC: value: type: EPLAN_VC name: My Colo to Network EPLAN_VC Connection bandwidth: 50 redundancy: priority: PRIMARY aSide: accessPoint: type: COLO port: href: https://api.equinix.com/fabric/v4/ports/2a4fb415-5a7f-436f-bae6-02f5e403deec uuid: 2a4fb415-5a7f-436f-bae6-02f5e403deec linkProtocol: type: DOT1Q vlanTag: 1137 zSide: accessPoint: type: NETWORK network: href: https://api.equinix.com/fabric/v4/networks/20d32a80-0d61-4333-bc03-707b591ae2f4 uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 project: projectId: a347a370-39b5-427f-c330-7471a9abd9 order: purchaseOrderNumber: 1-129105284100 notifications: - type: ALL emails: - test@test.com CreateConnectionDryRunResponse-Colo2Network-EVPLAN_VC: value: type: EVPLAN_VC name: My Colo to Network EVPLAN_VC Connection bandwidth: 50 redundancy: priority: PRIMARY aSide: accessPoint: type: COLO port: href: https://api.equinix.com/fabric/v4/ports/2a4fb415-5a7f-436f-bae6-02f5e403deec uuid: 2a4fb415-5a7f-436f-bae6-02f5e403deec linkProtocol: type: DOT1Q vlanTag: 1137 zSide: accessPoint: type: NETWORK network: href: https://api.equinix.com/fabric/v4/networks/25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 uuid: 25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 project: projectId: a347a370-39b5-427f-c330-7471a9abd9 order: purchaseOrderNumber: 1-129105284100 notifications: - type: ALL emails: - test@test.com CreateConnectionDryRunResponse-Colo2Sp-Generic: value: type: EVPL_VC name: My-EVPL-Connection bandwidth: 50 redundancy: priority: PRIMARY aSide: accessPoint: type: COLO port: href: https://api.equinix.com/fabric/v4/ports/2a4fb415-5a7f-436f-bae6-02f5e403deec uuid: 2a4fb415-5a7f-436f-bae6-02f5e403deec linkProtocol: type: DOT1Q vlanTag: 1137 zSide: accessPoint: type: SP profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/92dc376a-a932-43aa-a6a2-c806dedbd784 type: L2_PROFILE uuid: 92dc376a-a932-43aa-a6a2-c806dedbd784 location: metroHref: https://api.equinix.com/fabric/v4/metros/DC metroCode: DC project: projectId: a347a370-39b5-427f-c330-7471a9abd9 order: purchaseOrderNumber: 1-129105284100 notifications: - type: ALL emails: - test@test.com CreateConnectionDryRunResponse-Fcr2Colo: value: type: EVPL_VC name: Fcr to Colo Connection bandwidth: 50 redundancy: priority: PRIMARY aSide: accessPoint: type: CLOUD_ROUTER router: href: https://api.equinix.com/fabric/v4/routers/66a21614-1c4a-11ec-9621-0242ac130002 uuid: 66a21614-1c4a-11ec-9621-0242ac130002 zSide: accessPoint: type: COLO port: href: https://api.equinix.com/fabric/v4/ports/2a4fb415-5a7f-436f-bae6-02f5e403deec uuid: 2a4fb415-5a7f-436f-bae6-02f5e403deec linkProtocol: type: DOT1Q vlanTag: 1137 project: projectId: a347a370-39b5-427f-c330-7471a9abd9 order: purchaseOrderNumber: 1-129105284100 notifications: - type: ALL emails: - test@test.com CreateConnectionDryRunResponse-Fcr2Ipwan: value: type: EVPL_VC name: Fcr to Ipwan Connection bandwidth: 50 redundancy: priority: PRIMARY aSide: accessPoint: type: CLOUD_ROUTER router: href: https://api.equinix.com/fabric/v4/routers/66a21614-1c4a-11ec-9621-0242ac130002 uuid: 66a21614-1c4a-11ec-9621-0242ac130002 zSide: accessPoint: network: href: https://api.equinix.com/fabric/v4/networks/20d32a80-0d61-4333-bc03-707b591ae2f4 uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 project: projectId: a347a370-39b5-427f-c330-7471a9abd9 order: purchaseOrderNumber: 1-129105284100 notifications: - type: ALL emails: - test@test.com CreateConnectionDryRunResponse-Fcr2Sp-Generic: value: type: EVPL_VC name: Fcr to Sp-Generic Connection bandwidth: 50 redundancy: priority: PRIMARY aSide: accessPoint: type: CLOUD_ROUTER router: href: https://api.equinix.com/fabric/v4/routers/66a21614-1c4a-11ec-9621-0242ac130002 uuid: 66a21614-1c4a-11ec-9621-0242ac130002 zSide: accessPoint: type: SP profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/92dc376a-a932-43aa-a6a2-c806dedbd784 type: L2_PROFILE uuid: 92dc376a-a932-43aa-a6a2-c806dedbd784 location: metroHref: https://api.equinix.com/fabric/v4/metros/DC metroCode: DC project: projectId: a347a370-39b5-427f-c330-7471a9abd9 order: purchaseOrderNumber: 1-129105284100 notifications: - type: ALL emails: - test@test.com CreateConnectionDryRunResponse-PortServiceToken2Port: value: type: EVPL_VC name: Port Service Token to Port Connection bandwidth: 50 redundancy: priority: PRIMARY aSide: serviceToken: uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 accessPoint: type: COLO port: href: https://api.equinix.com/fabric/v4/ports/20d32a80-0d61-4333-bc03-707b591ae2f5 uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 linkProtocol: type: DOT1Q vlanTag: 1137 zSide: accessPoint: type: COLO port: href: https://api.equinix.com/fabric/v4/ports/2a4fb415-5a7f-436f-bae6-02f5e403deec uuid: 2a4fb415-5a7f-436f-bae6-02f5e403deec linkProtocol: type: DOT1Q vlanTag: 1137 project: projectId: a347a370-39b5-427f-c330-7471a9abd9 order: purchaseOrderNumber: 1-129105284100 notifications: - type: ALL emails: - test@test.com ConnectionCreateResponse: value: href: https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62 type: EVPL_VC uuid: 3a58dd05-f46d-4b1d-a154-2e85c396ea62 name: My-Layer2-Connection-3 bandwidth: 1000 direction: OUTGOING isRemote: true state: ACTIVE redundancy: group: e04db764-f865-470b-8394-d2efdd651577 priority: PRIMARY aSide: accessPoint: type: COLO port: href: https://api.equinix.com/fabric/v4/ports/a00cef6f-8e35-4794-9ff9-665e084e4e6d uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d linkProtocol: type: DOT1Q vlanTag: 1001 zSide: accessPoint: type: SP profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c location: metroHref: https://api.equinix.com/fabric/v4/metros/MX metroCode: MX operation: providerStatus: PROVISIONING equinixStatus: PROVISIONING changeLog: createdDateTime: 2020-05-21T10:30:00Z COLO2GoogleSPwithDot1q-Response: value: type: EVPL_VC href: https://api.equinix.com/fabric/v4/connections/f662d4c4-fcd8-40ba-b95b-64fc7e0a61fb uuid: f662d4c4-fcd8-40ba-b95b-64fc7e0a61fb name: My-Layer2-Connection-3 operation: providerStatus: PROVISIONING equinixStatus: PROVISIONING order: purchaseOrderNumber: po1234 billingTier: Up to 50 MB notifications: - type: ALL emails: - fabric@equinix.com changeLog: createdBy: fabric createdByFullName: fabric createdByEmail: fabric@equinix.com createdDateTime: 2024-04-25T14:25:30.509Z updatedBy: fabric updatedByFullName: fabric updatedByEmail: fabric@equinix.com updatedDateTime: 2024-04-25T14:25:30.509Z bandwidth: 50 redundancy: group: 2673c07d-9bd3-43c2-9827-91e940d01a54 priority: PRIMARY aSide: accessPoint: location: metroCode: DA port: type: XF_PORT href: https://api.equinix.com/fabric/v4/ports/33353aa1-18f2-4b32-94d6-59a12500f7e2 uuid: 33353aa1-18f2-4b32-94d6-59a12500f7e2 name: 1-DA1-port linkProtocol: type: DOT1Q vlanTag: 1001 zSide: accessPoint: location: metroCode: SV profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/bd4570e2-d792-4a00-87f5-3bde040cdcd7 type: L2_PROFILE name: Google Cloud Partner Interconnect Zone 1 uuid: bd4570e2-d792-4a00-87f5-3bde040cdcd7 sellerRegion: us-west2 authenticationKey: xx-xxx-xx-xxxxx/us-west2/1 COLO2AlibabaSP-Response: value: type: EVPL_VC href: https://api.equinix.com/fabric/v4/connections/2c7bb68e-f560-41ac-9950-e62c87be191e uuid: 2c7bb68e-f560-41ac-9950-e62c87be191e name: vd2alibaba-connection-1 operation: providerStatus: PROVISIONING equinixStatus: PROVISIONING order: billingTier: Up to 50 MB notifications: - type: ALL emails: - fabric@equinix.com changeLog: createdBy: fabric createdByFullName: fabric createdByEmail: fabric@equinix.com createdDateTime: 2024-05-02T20:07:38.626Z updatedBy: fabric updatedByFullName: fabric updatedByEmail: fabric@equinix.com updatedDateTime: 2024-05-02T20:07:38.626Z bandwidth: 50 redundancy: group: 6aafb605-f3e4-4380-a9c0-1eddf829bca0 priority: PRIMARY aSide: accessPoint: location: metroCode: SV port: type: XF_PORT href: https://api.equinix.com/fabric/v4/ports/b54d71a6-aecb-40cc-b458-8a4103f5cdba uuid: b54d71a6-aecb-40cc-b458-8a4103f5cdba name: 641728-SV5-1 linkProtocol: type: DOT1Q vlanTag: 1018 zSide: accessPoint: location: metroCode: SV profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/4c4b8edf-873b-4c6c-805a-edb2c335bd6c type: L2_PROFILE name: Alibaba Cloud Express Connect uuid: 4c4b8edf-873b-4c6c-805a-edb2c335bd6c sellerRegion: us-west-1 authenticationKey: xxxx-xxx-xxxx COLO2OracleSP-Response: value: type: EVPL_VC href: https://api.equinix.com/fabric/v4/connections/6c157170-f84d-424a-9396-b5d6ee723296 uuid: 6c157170-f84d-424a-9396-b5d6ee723296 name: vd2oracle-connection-1 operation: providerStatus: PROVISIONING equinixStatus: PROVISIONING order: purchaseOrderNumber: 1-129105284100 billingTier: Up to 1G notifications: - type: ALL emails: - fabric@equinix.com changeLog: createdBy: fabric createdByFullName: fabric createdByEmail: fabric@equinix.com createdDateTime: 2024-05-02T20:25:09.841Z updatedBy: fabric updatedByFullName: fabric updatedByEmail: fabric@equinix.com updatedDateTime: 2024-05-02T20:25:09.841Z bandwidth: 1000 redundancy: group: e8400059-34e1-47f1-9914-cb5907ee7913 priority: PRIMARY aSide: accessPoint: location: metroCode: SV port: type: XF_PORT href: https://api.equinix.com/fabric/v4/ports/b54d71a6-aecb-40cc-b458-8a4103f5cdba uuid: b54d71a6-aecb-40cc-b458-8a4103f5cdba name: 641728-SV5-1 linkProtocol: type: DOT1Q vlanTag: 1021 zSide: accessPoint: location: metroCode: DC profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/60ef0382-cdaa-44e7-bd36-b803731816b8 type: L2_PROFILE name: Oracle Cloud Infrastructure FastConnect uuid: 60ef0382-cdaa-44e7-bd36-b803731816b8 sellerRegion: us-ashburn-1 authenticationKey: ocid1.virtualcircuit.oc1.iad-xxx-xxxx Vd2Sp-Response: value: href: https://api.equinix.com/fabric/v4/connections/f37e40c5-2802-4df7-9732-839a8a5868ce uuid: f37e40c5-2802-4df7-9732-839a8a5868ce type: EVPL_VC name: vd to SP bandwidth: 50 state: ACTIVE account: accountNumber: 201246 orgId: 92610 redundancy: group: ac61e576-2830-46aa-85e6-5ae7cd49610c priority: PRIMARY aSide: accessPoint: virtualDevice: type: EDGE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 interface: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d type: NETWORK id: 2 location: metroHref: https://api.equinix.com/fabric/v4/metros/SG metroCode: SG zSide: accessPoint: profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/95542b34-cf1c-41aa-89f7-590946f9df53 uuid: 95542b34-cf1c-41aa-89f7-590946f9df53 type: L2_PROFILE location: metroHref: https://api.equinix.com/fabric/v4/metros/SV metroCode: SV order: purchaseOrderNumber: 1-323292 billingTier: Up to 50 MB notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com operation: equinixStatus: PENDING_APPROVAL providerStatus: NOT_AVAILABLE changeLog: createdDateTime: 2022-10-05T19:37:12.748Z Vd2ServiceToken_Response: value: href: https://api.equinix.com/fabric/v4/connections/ebc37e2e-c36b-4e93-86a4-fc4efce7abc8 type: EVPL_VC uuid: ebc37e2e-c36b-4e93-86a4-fc4efce7abc8 name: Test ST state: ACTIVE account: accountNumber: 270235 orgId: 92794 globalOrgId: 0016u000003JZ55AAG bandwidth: 50 redundancy: group: b64dad2a-2763-4084-bc50-b36ef4f67137 priority: PRIMARY isRemote: true direction: INTERNAL aSide: accessPoint: interface: uuid: 11fd6067-149f-4142-a5b4-54a8dd6f53fe id: 6 type: CLOUD type: VD account: accountNumber: 270217 organizationName: test location: metroHref: https://api.equinix.com/fabric/v4/metros/DC region: AMER metroName: Ashburn metroCode: DC virtualDevice: href: https://api.equinix.com/ne/v1/devices/3539f96c-7f67-4696-90f3-7b6d2fdcde5f uuid: 3539f96c-7f67-4696-90f3-7b6d2fdcde5f name: testing1234 type: EDGE zSide: serviceToken: uuid: e05f4f23-d098-4d7c-a9ca-c2897b465107 account: orgId: 22222 accessPoint: type: COLO account: accountNumber: 22222 organizationName: xxxxx location: metroHref: https://api.equinix.com/fabric/v4/metros/DC region: AMER metroName: Ashburn metroCode: DC port: href: https://api.equinix.com/fabric/v4/ports/c791f8cb-59d0-9d00-8ce0-306a5c00a4ee uuid: c791f8cb-59d0-9d00-8ce0-306a5c00a4ee name: testNEuser2-DC6-NL-Dot1q-STD-SEC-10G-JN-216 linkProtocol: type: DOT1Q vlanTag: 553 changeLog: createdBy: test createdDateTime: 2022-10-05T19:37:12.748Z updatedBy: test updatedDateTime: 2022-10-05T19:37:12.748Z operation: providerStatus: AVAILABLE equinixStatus: PROVISIONED notifications: - type: ALL emails: - test@equinix.com Vd2Colo-Response: value: href: https://api.equinix.com/fabric/v4/connections/f37e40c5-2802-4df7-9732-839a8a5868ce uuid: f37e40c5-2802-4df7-9732-839a8a5868ce type: EVPL_VC name: vd to COLO bandwidth: 50 redundancy: group: ac61e576-2830-46aa-85e6-5ae7cd49610c priority: PRIMARY order: purchaseOrderNumber: 1-323292 billingTier: Up to 50 MB notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com operation: equinixStatus: PROVISIONING providerStatus: NOT_AVAILABLE account: accountNumber: 201246 orgId: 92610 changeLog: createdDateTime: 2021-10-27 16:25:37.229Z aSide: accessPoint: virtualDevice: type: EDGE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 interface: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d type: NETWORK id: 4 location: metroHref: https://api.equinix.com/fabric/v4/metros/SG metroCode: SG zSide: accessPoint: type: COLO port: href: https://api.equinix.com/fabric/v4/ports/20d32a80-0d61-4333-bc03-707b591ae2f4 type: XF_PORT uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 linkProtocol: type: DOT1Q vlanTag: 300 Vd2Colo-VlanTagResponse: value: href: https://api.equinix.com/fabric/v4/connections/f37e40c5-2802-4df7-9732-839a8a5868ce uuid: f37e40c5-2802-4df7-9732-839a8a5868ce type: EVPL_VC name: vd to COLO bandwidth: 50 redundancy: group: ac61e576-2830-46aa-85e6-5ae7cd49610c priority: PRIMARY order: purchaseOrderNumber: 1-323292 billingTier: Up to 50 MB account: accountNumber: 201246 orgId: 92610 notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com operation: equinixStatus: PROVISIONING providerStatus: NOT_AVAILABLE changeLog: createdDateTime: 2021-10-27 16:25:37.229 aSide: accessPoint: virtualDevice: type: EDGE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 interface: uuid: 20d32a80-0d61-4333-bc03-707b591ae2f88 type: NETWORK id: 2 location: metroHref: https://api.equinix.com/fabric/v4/metros/SG metroCode: SG zSide: accessPoint: type: COLO port: href: https://api.equinix.com/fabric/v4/ports/20d32a80-0d61-4333-bc03-707b591ae2f4 type: XF_PORT uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 linkProtocol: type: DOT1Q vlanTag: 300 Vd2ColoUntagged-Response: value: href: https://api.equinix.com/fabric/v4/connections/f37e40c5-2802-4df7-9732-839a8a5868ce uuid: f37e40c5-2802-4df7-9732-839a8a5868ce type: EVPL_VC name: vd to SP bandwidth: 50 redundancy: group: ac61e576-2830-46aa-85e6-5ae7cd49610c priority: PRIMARY order: purchaseOrderNumber: 1-323292 billingTier: Up to 50 MB account: accountNumber: 201246 orgId: 92610 notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com operation: equinixStatus: PROVISIONING providerStatus: NOT_AVAILABLE changeLog: createdDateTime: 2021-10-27 16:25:37.229Z aSide: accessPoint: virtualDevice: type: EDGE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 interface: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d type: NETWORK id: 4 location: metroHref: https://api.equinix.com/fabric/v4/metros/SG metroCode: SG zSide: accessPoint: type: COLO port: href: https://api.equinix.com/fabric/v4/ports/20d32a80-0d61-4333-bc03-707b591ae2f4 type: XF_PORT uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 linkProtocol: type: UNTAGGED Fcr2Sp-Response: value: href: https://api.equinix.com/fabric/v4/connections/0ed42ea7-2df8-470d-ad59-e432d768b4f1 type: IP_VC uuid: 0ed42ea7-2df8-470d-ad59-e432d768b4f1 name: GP_FG2GCP_001 bandwidth: 50 redundancy: group: 4f786b3f-27d4-48e0-8571-423d085826c1 priority: PRIMARY order: billingTier: Up to 50 MB aSide: accessPoint: type: CLOUD_ROUTER router: href: https://api.equinix.com/fabric/v4/routers/56d267f3-a566-47a8-8cf9-40e6cc925bf0 uuid: 56d267f3-a566-47a8-8cf9-40e6cc925bf0 name: My-FG-1 zSide: accessPoint: profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/c7922adf-34b5-4d4e-a87c-cae8c899ef90 uuid: c7922adf-34b5-4d4e-a87c-cae8c899ef90 name: Google Cloud Partner Interconnect Zone 2 type: L2_PROFILE authenticationKey: xx-xxx-xx-xxxxx/xxx/x sellerRegion: us-west1 location: metroHref: https://api.equinix.com/fabric/v4/metros/SV metroCode: SV operation: equinixStatus: PROVISIONING providerStatus: PROVISIONING notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com changeLog: createdBy: test createdByFullName: test createdByEmail: test@equinix.com createdDateTime: 2022-05-12T17:53:45.401Z Fcr2Colo-ResponseExample: value: href: https://api.equinix.com/fabric/v4/connections/0ed42ea7-2df8-470d-ad59-e432d768b4f1 type: IP_VC uuid: 0ed42ea7-2df8-470d-ad59-e432d768b4f1 name: GP_FG2COLO_001 bandwidth: 50 redundancy: group: 4f786b3f-27d4-48e0-8571-423d085826c1 priority: PRIMARY order: billingTier: Up to 50 MB aSide: accessPoint: type: CLOUD_ROUTER router: href: https://api.equinix.com/fabric/v4/routers/56d267f3-a566-47a8-8cf9-40e6cc925bf0 uuid: 56d267f3-a566-47a8-8cf9-40e6cc925bf0 zSide: accessPoint: type: COLO port: href: https://api.equinix.com/fabric/v4/ports/a00cef6f-8e35-4794-9ff9-665e084e4e6d uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d linkProtocol: type: DOT1Q vlanTag: 1001 operation: equinixStatus: PENDING_INTERFACE_CONFIGURATION providerStatus: NOT_AVAILABLE notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com changeLog: createdBy: test createdByFullName: test createdByEmail: test@equinix.com createdDateTime: 2022-05-12T17:53:45.401Z Fcr2IpWan-response: value: href: https://api.equinix.com/fabric/v4/connections/0ed42ea7-2df8-470d-ad59-e432d768b4f1 type: IPWAN_VC uuid: 0ed42ea7-2df8-470d-ad59-e432d768b4f1 name: MY-IPWAN-CONNECTION-1 bandwidth: 50 redundancy: group: 4f786b3f-27d4-48e0-8571-423d085826c1 priority: PRIMARY order: billingTier: Up to 50 MB aSide: accessPoint: type: CLOUD_ROUTER router: href: https://api.equinix.com/fabric/v4/routers/66a21614-1c4a-11ec-9621-0242ac130002 uuid: 66a21614-1c4a-11ec-9621-0242ac130002 name: My-FG zSide: accessPoint: network: href: https://api.equinix.com/fabric/v4/networks/25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 uuid: 25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 name: My-IPWAN platformUuid: be2c3921-602a-444e-86ef-92cf749c7647 state: ACTIVE type: IPWAN scope: REGIONAL location: region: AMER operation: equinixStatus: PROVISIONING providerStatus: NOT_AVAILABLE notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com changeLog: createdBy: test createdByFullName: test createdByEmail: test@equinix.com createdDateTime: 2022-05-12T17:53:45.401Z Fcr2Sp-marketplaceSubscription-Response: value: href: https://api.equinix.com/fabric/v4/connections/0ed42ea7-2df8-470d-ad59-e432d768b4f1 type: IP_VC uuid: 0ed42ea7-2df8-470d-ad59-e432d768b4f1 name: GP_FG2GCP_001 bandwidth: 50 redundancy: group: 4f786b3f-27d4-48e0-8571-423d085826c1 priority: PRIMARY order: billingTier: Up to 50 MB aSide: accessPoint: type: CLOUD_ROUTER router: href: https://api.equinix.com/fabric/v4/routers/56d267f3-a566-47a8-8cf9-40e6cc925bf0 uuid: 56d267f3-a566-47a8-8cf9-40e6cc925bf0 zSide: accessPoint: type: SP profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/c7922adf-34b5-4d4e-a87c-cae8c899ef90 uuid: c7922adf-34b5-4d4e-a87c-cae8c899ef90 marketplaceSubscription: href: https://api.equinix.com/fabric/v4/marketplaceSubscriptions/20d32a80-0d61-4333-bc03-707b591ae2f5 type: AWS_MARKETPLACE_SUBSCRIPTION uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 operation: equinixStatus: PROVISIONING providerStatus: PROVISIONING notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com changeLog: createdBy: test createdByFullName: test createdByEmail: test@equinix.com createdDateTime: 2022-05-12T17:53:45.401Z AsideServiceToken2PortResponseWithDot1q: value: href: https://api.equinix.com/fabric/v4/connections/a00cef6f-8e35-4794-9ff9-665e084e4e6d type: EVPL_VC uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d name: a-token qinq-dot1q state: ACTIVE operation: providerStatus: NOT_AVAILABLE equinixStatus: PROVISIONING notifications: - type: ALL emails: - test@equinix.com account: accountNumber: 201246 orgId: 92610 globalOrgId: 0017i000011X250AAC changeLog: createdBy: testuser createdDateTime: 2022-05-16T07:50:49.749Z bandwidth: 50 redundancy: group: a00cef6f-8e35-4794-9ff9-665e084e4e6d priority: PRIMARY isRemote: true direction: OUTGOING aSide: serviceToken: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d accessPoint: location: metroHref: https://api.equinix.com/fabric/v4/metros/SV metroCode: SV port: href: https://api.equinix.com/fabric/v4/ports/a00cef6f-8e35-4794-9ff9-665e084e4e6d uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d name: test-port-name-2 linkProtocol: type: DOT1Q vlanTag: 1231 account: accountNumber: 201246 organizationName: testOrganization zSide: accessPoint: location: metroHref: https://api.equinix.com/fabric/v4/metros/LD region: EMEA metroName: London metroCode: LD port: href: https://api.equinix.com/fabric/v4/ports/a00cef6f-8e35-4794-9ff9-665e084e4e6d uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d name: test-port-name-1 linkProtocol: type: DOT1Q vlanTag: 1321 account: accountNumber: 201246 organizationName: xxxxx order: purchaseOrderNumber: "1122334" billingTier: Up to 50 MB AsideServiceToken2PortResponseWithQinq: value: href: https://api.equinix.com/fabric/v4/connections/a00cef6f-8e35-4794-9ff9-665e084e4e6d type: EVPL_VC uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d name: a-token qinq-dot1q state: ACTIVE operation: providerStatus: NOT_AVAILABLE equinixStatus: PROVISIONING notifications: - type: ALL emails: - test@equinix.com account: accountNumber: 201246 orgId: 92610 globalOrgId: 0017i000011X250AAC changeLog: createdBy: testuser createdDateTime: 2022-05-16T07:50:49.749Z bandwidth: 50 redundancy: group: a00cef6f-8e35-4794-9ff9-665e084e4e6d priority: PRIMARY isRemote: true direction: OUTGOING aSide: serviceToken: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d accessPoint: location: metroHref: https://api.equinix.com/fabric/v4/metros/SV region: AMER metroName: Silicon Valley metroCode: SV port: href: https://api.equinix.com/fabric/v4/ports/a00cef6f-8e35-4794-9ff9-665e084e4e6d uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d name: test-port-name-2 linkProtocol: type: QINQ vlanSTag: 1231 vlanCTag: 2233 account: accountNumber: 201246 organizationName: xxxxx zSide: accessPoint: location: metroHref: https://api.equinix.com/fabric/v4/metros/LD region: EMEA metroName: London metroCode: LD port: href: https://api.equinix.com/fabric/v4/ports/a00cef6f-8e35-4794-9ff9-665e084e4e6d uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d name: test-port-name-1 linkProtocol: type: DOT1Q vlanTag: 1321 account: accountNumber: 201246 organizationName: xxxxx order: purchaseOrderNumber: "1122334" billingTier: Up to 50 MB Metal2Sp-Aws-Response: value: href: https://api.equinix.com/fabric/v4/connections/f37e40c5-2802-4df7-9732-839a8a5868ce type: EVPL_VC uuid: f37e40c5-2802-4df7-9732-839a8a5868ce name: My-Metal2Aws-Connection bandwidth: 1000 aSide: accessPoint: type: METAL_NETWORK virtualNetwork: href: https://api.equinix.com/metal/v1/virtual-networks/a867f685-41b0-1b07-6de0-320a5c00abd uuid: a867f685-41b0-1b07-6de0-320a5c00abd interface: projectId: 497f6eca-6276-4993-bfeb-53cbbbba6f08 zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 9127bb72-5f4f-4517-be74-3af7ce612687 authenticationKey: xxxx-xxx-xxxx sellerRegion: us-west-1 order: purchaseOrderNumber: 1-129105284100 project: projectId: 567 operation: equinixStatus: PROVISIONING providerStatus: NOT_AVAILABLE account: href: https://api.equinix.com/accountService/v1/accounts/123213 accountNumber: 123213 notifications: - type: ALL emails: - fabric@gmail.com - fabric1@gmail.com changeLog: createdBy: fabric createdByEmail: fabric@gmail.com createdByFullName: fabric createdDateTime: 2020-05-21T10:30:00Z Metal2Sp-Azure-Response: value: type: EVPL_VC href: https://api.equinix.com/fabric/v4/connections/d3b69c6b-3b23-4ac0-a1bb-8db16460714d uuid: d3b69c6b-3b23-4ac0-a1bb-8db16460714d name: Metal2Azure Connection operation: providerStatus: PROVISIONING equinixStatus: PROVISIONING order: billingTier: Up to 50 MB notifications: - type: ALL emails: - eqxfabricamcrh@gmail.com changeLog: createdBy: fabric createdByFullName: fabric createdByEmail: fabric@gmail.com createdDateTime: 2024-03-21T20:14:04.072Z updatedBy: fabric updatedByFullName: fabric updatedByEmail: fabric@gmail.com updatedDateTime: 2024-03-21T20:14:04.072Z bandwidth: 50 redundancy: group: 3cbd354d-d147-4552-bfd0-78c559b4cc91 priority: PRIMARY aSide: accessPoint: type: METAL_NETWORK virtualNetwork: uuid: c652cef9-4e52-4165-b997-d0f52b5a18dd interconnection: uuid: a00f1a2a-e50e-4019-ba86-0768dac8396c zSide: accessPoint: location: metroCode: SV profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/a1390b22-bbe0-4e93-ad37-85beef9d254d type: L2_PROFILE name: Azure ExpressRoute uuid: a1390b22-bbe0-4e93-ad37-85beef9d254d authenticationKey: xxxxxxxxx Metal2Sp-GCP-Response: value: type: EVPL_VC href: https://api.equinix.com/fabric/v4/connections/d3b69c6b-3b23-4ac0-a1bb-8db16460714d uuid: d3b69c6b-3b23-4ac0-a1bb-8db16460714d name: My-Metal2GCP-Connection operation: providerStatus: PROVISIONING equinixStatus: PROVISIONING order: billingTier: Up to 50 MB notifications: - type: ALL emails: - fabric@gmail.com changeLog: createdBy: fabric createdByFullName: fabric createdByEmail: fabric@gmail.com createdDateTime: 2024-03-21T20:14:04.072Z updatedBy: fabric updatedByFullName: fabric updatedByEmail: fabric@gmail.com updatedDateTime: 2024-03-21T20:14:04.072Z bandwidth: 50 redundancy: group: 3cbd354d-d147-4552-bfd0-78c559b4cc91 priority: PRIMARY aSide: accessPoint: type: METAL_NETWORK virtualNetwork: uuid: c652cef9-4e52-4165-b997-d0f52b5a18dd interconnection: uuid: a00f1a2a-e50e-4019-ba86-0768dac8396c zSide: accessPoint: location: metroCode: SV profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/063f4b0f-2d5b-4db7-95da-d9eddfc92602 type: L2_PROFILE name: GCP Service Profile uuid: 063f4b0f-2d5b-4db7-95da-d9eddfc92602 authenticationKey: xxxx-xxx-xxxx Metal2Sp-Oracle-Response: value: type: EVPL_VC href: https://api.equinix.com/fabric/v4/connections/7a21d5d8-f153-45f8-ad76-f92babf3f103 uuid: 7a21d5d8-f153-45f8-ad76-f92babf3f103 name: Metal2Oracle-Connection operation: providerStatus: PROVISIONING equinixStatus: PROVISIONING order: billingTier: Up to 50Mb notifications: - type: ALL emails: - test@gmail.com changeLog: createdBy: fabric createdByFullName: fabric createdByEmail: fabric@gmail.com createdDateTime: 2024-03-19T23:09:15.547Z updatedBy: fabric updatedByFullName: fabric updatedByEmail: fabric@gmail.com updatedDateTime: 2024-03-19T23:09:15.547Z bandwidth: 50 redundancy: group: 9674d5cf-03a4-4129-933f-60d21e0f3ddb priority: PRIMARY aSide: accessPoint: type: METAL_NETWORK virtualNetwork: uuid: d357394a-3453-415b-8bf3-4ea95b3b13fd interconnection: uuid: 7fcf077d-3383-4e22-9173-7b415fdfd1bd zSide: accessPoint: location: metroCode: SV profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/60ef0382-cdaa-44e7-bd36-b803731816b8 type: L2_PROFILE name: Oracle Cloud Infrastructure FastConnect uuid: 60ef0382-cdaa-44e7-bd36-b803731816b8 sellerRegion: us-sanjose-1 authenticationKey: xxxxxxxxx Metal2Sp-IBM-Response: value: type: EVPL_VC href: https://api.equinix.com/fabric/v4/connections/f0e56501-d92f-4ca3-b047-f95628d4a32a uuid: f0e56501-d92f-4ca3-b047-f95628d4a32a name: Metal2IBM-Connection operation: providerStatus: PROVISIONING equinixStatus: PROVISIONING order: billingTier: Up to 50 MB notifications: - type: ALL emails: - dragons-qa3@equinix.com changeLog: createdBy: fabric createdByFullName: fabric createdByEmail: fabric@equinix.com createdDateTime: 2024-03-06T17:20:41.574Z updatedBy: fabric updatedByFullName: fabric updatedByEmail: fabric@equinix.com updatedDateTime: 2024-03-06T17:20:41.574Z bandwidth: 50 redundancy: group: edf883ed-3ea0-4adf-b58c-4ea163c612d5 priority: PRIMARY aSide: accessPoint: type: METAL_NETWORK virtualNetwork: uuid: 497f6eca-6276-4993-bfeb-53cbbbba6f08 interconnection: uuid: 497f6eca-6276-4993-bfeb-53cbbbba6f08 zSide: accessPoint: location: metroCode: SV profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/317dcd1c-83ba-4d7c-994a-3e7ddb875026 type: L2_PROFILE name: IBM Cloud Direct Link 2 uuid: 317dcd1c-83ba-4d7c-994a-3e7ddb875026 sellerRegion: San Jose 2 authenticationKey: xxxxxxxxx Metal2Port-Dot1q-Response: value: type: EVPL_VC href: https://api.equinix.com/fabric/v4/connections/02b7b7d4-1726-4451-9598-e28091c096cd uuid: 02b7b7d4-1726-4451-9598-e28091c096cd name: Metal2Port-dot1q operation: providerStatus: NOT_AVAILABLE equinixStatus: PROVISIONING order: billingTier: Up to 50 MB notifications: - type: ALL emails: - test@equinix.com changeLog: createdBy: fabric createdByFullName: fabric createdByEmail: fabric@equinix.com createdDateTime: 2024-03-20T00:39:07.648Z updatedBy: fabric updatedByFullName: fabric updatedByEmail: fabric@equinix.com updatedDateTime: 2024-03-20T00:39:07.648Z bandwidth: 50 redundancy: group: b76b3167-ae8e-42c4-9571-b659f9779897 priority: PRIMARY aSide: accessPoint: type: METAL_NETWORK virtualNetwork: uuid: 497f6eca-6276-4993-bfeb-53cbbbba6f08 interconnection: uuid: 497f6eca-6276-4993-bfeb-53cbbbba6f08 zSide: accessPoint: location: metroCode: SV port: href: https://api.equinix.com/fabric/v4/ports/6c73d02c-87e1-4642-8e18-01eb4b87e243 type: XF_PORT uuid: 6c73d02c-87e1-4642-8e18-01eb4b87e243 name: 290061-SV1-CX-SEC-01 linkProtocol: type: DOT1Q vlanTag: 1387 Metal2Port-Qinq-Response: value: type: EVPL_VC href: https://api.equinix.com/fabric/v4/connections/d87489aa-c32d-4756-a81a-6f557afb871d uuid: d87489aa-c32d-4756-a81a-6f557afb871d name: Metal2Port-qinq operation: providerStatus: NOT_AVAILABLE equinixStatus: PROVISIONING order: billingTier: Up to 50 MB notifications: - type: ALL emails: - test@equinix.com changeLog: createdBy: fabric createdByFullName: fabric createdByEmail: fabric@equinix.com createdDateTime: 2024-03-21T23:44:22.347Z updatedBy: fabric updatedByFullName: fabric updatedByEmail: fabric@equinix.com updatedDateTime: 2024-03-21T23:44:22.347Z bandwidth: 50 redundancy: group: d3cf59c0-33d7-4b9d-94c6-e60b27c363d3 priority: PRIMARY aSide: accessPoint: type: METAL_NETWORK virtualNetwork: uuid: 497f6eca-6276-4993-bfeb-53cbbbba6f08 interconnection: uuid: 497f6eca-6276-4993-bfeb-53cbbbba6f08 zSide: accessPoint: location: metroCode: SV port: href: https://api.equinix.com/fabric/v4/ports/4ff4047c-7217-4b79-9943-c2c4a2f7324d type: XF_PORT uuid: 4ff4047c-7217-4b79-9943-c2c4a2f7324d name: 290061-SV1-CX-PRI-02 linkProtocol: type: QINQ vlanSTag: 134 vlanCTag: 439 Metal2ServiceToken-Response: value: type: EVPL_VC href: https://api.equinix.com/fabric/v4/connections/f712745e-ccf9-4a0d-9e4d-83c1bb5b9028 uuid: f712745e-ccf9-4a0d-9e4d-83c1bb5b9028 name: Metal2ServiceToken operation: providerStatus: NOT_AVAILABLE equinixStatus: PROVISIONING order: billingTier: Up to 50 MB notifications: - type: ALL emails: - test@equinix.com changeLog: createdBy: fabric createdByFullName: fabric createdByEmail: fabric@equinix.com createdDateTime: 2024-03-20T20:12:08.595Z updatedBy: fabric updatedByFullName: fabric updatedByEmail: fabric@equinix.com updatedDateTime: 2024-03-20T20:12:08.595Z bandwidth: 50 redundancy: group: fc504dcf-8697-4860-80cd-6a7afaa52586 priority: PRIMARY aSide: accessPoint: type: METAL_NETWORK virtualNetwork: uuid: 497f6eca-6276-4993-bfeb-53cbbbba6f08 interconnection: uuid: 497f6eca-6276-4993-bfeb-53cbbbba6f08 zSide: serviceToken: href: https://api.equinix.com/fabric/v4/serviceTokens/bc1383be-579a-4d75-ae19-b0d487bbff90 uuid: bc1383be-579a-4d75-ae19-b0d487bbff90 project: projectId: "377533000114703" accessPoint: location: metroCode: SV port: href: https://api.equinix.com/fabric/v4/ports/6c73d02c-87e1-4642-8e18-01eb4b87e243 type: XF_PORT uuid: 6c73d02c-87e1-4642-8e18-01eb4b87e243 name: 290061-SV1-CX-SEC-01 linkProtocol: type: DOT1Q vlanTag: 4087 Metal2Sp-Generic-Response: value: type: EVPL_VC href: https://api.equinix.com/fabric/v4/connections/1a9ffa8f-d4d4-44ab-9733-362c9a36ec94 uuid: 1a9ffa8f-d4d4-44ab-9733-362c9a36ec94 name: Metal2Generic operation: providerStatus: NOT_AVAILABLE equinixStatus: PENDING_APPROVAL order: billingTier: Up to 1G notifications: - type: ALL emails: - test@test.com changeLog: createdBy: fabric createdByFullName: fabric createdByEmail: fabric@equinix.com createdDateTime: 2024-03-22T00:42:35.386Z updatedBy: fabric updatedByFullName: fabric updatedByEmail: fabric@equinix.com updatedDateTime: 2024-03-22T00:42:35.386Z bandwidth: 1000 redundancy: group: dd22cd15-4d09-45b3-9523-37daf075a27d priority: PRIMARY aSide: accessPoint: type: METAL_NETWORK virtualNetwork: uuid: 497f6eca-6276-4993-bfeb-53cbbbba6f08 interconnection: uuid: 497f6eca-6276-4993-bfeb-53cbbbba6f08 zSide: accessPoint: location: metroCode: SV profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/f1a247aa-8f86-4a89-88c2-72497686cd0d type: L2_PROFILE name: Generic Service Profile uuid: f1a247aa-8f86-4a89-88c2-72497686cd0d MCNS2Sp-Alibaba-Response: value: href: https://api.equinix.com/fabric/v4/connections/974cb1c6-5090-4796-9d38-f5c14432d2c4 type: EVPL_VC uuid: 974cb1c6-5090-4796-9d38-f5c14432d2c4 name: My-MCNS2Alibaba-Connection operation: providerStatus: PROVISIONING equinixStatus: PROVISIONING order: billingTier: Up to 50 MB notifications: - type: ALL emails: - fabric@gmail.com changeLog: createdBy: fabric createdByFullName: fabric createdByEmail: fabric@gmail.com createdDateTime: 2024-09-07T05:35:23.750Z updatedBy: fabric updatedByFullName: fabric updatedByEmail: fabric@gmail.com updatedDateTime: 2024-09-07T05:35:23.750Z bandwidth: 50 redundancy: group: 9d92f86f-2c2a-4b88-b9a1-a61ec83c28cf priority: PRIMARY aSide: accessPoint: type: VPIC_INTERFACE vpicInterface: uuid: cd67f685-41b0-1b07-6de0-0320a5c00abe zSide: accessPoint: location: metroHref: https://api.corp.equinix.com/fabric/v4/metros/DC metroCode: DC profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/4c4b8edf-873b-4c6c-805a-edb2c335bd6c type: L2_PROFILE name: Alibaba Cloud Express Connect uuid: 4c4b8edf-873b-4c6c-805a-edb2c335bd6c sellerRegion: us-east-1 authenticationKey: xxxx-xxx-xxxx MCNS2Sp-Aws-Response: value: href: https://api.equinix.com/fabric/v4/connections/729a1248-afa5-4dee-a4e7-5f24cab53287 type: EVPL_VC uuid: 729a1248-afa5-4dee-a4e7-5f24cab53287 name: My-MCNS2AWS-Connection operation: providerStatus: PROVISIONING equinixStatus: PROVISIONING order: billingTier: Up to 50 MB notifications: - type: ALL emails: - fabric@gmail.com changeLog: createdBy: fabric createdByFullName: fabric createdByEmail: fabric@gmail.com createdDateTime: 2024-09-06T17:08:45.548Z updatedBy: fabric updatedByFullName: fabric updatedByEmail: fabric@gmail.com updatedDateTime: 2024-09-06T17:08:45.548Z bandwidth: 50 redundancy: group: 75346f39-4193-466e-9a83-78c7e153f6e2 priority: PRIMARY aSide: accessPoint: type: VPIC_INTERFACE vpicInterface: uuid: cd67f685-41b0-1b07-6de0-0320a5c00abe zSide: accessPoint: location: metroHref: https://api.corp.equinix.com/fabric/v4/metros/DC metroCode: DC profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/69ee618d-be52-468d-bc99-00566f2dd2b9 type: L2_PROFILE name: AWS Direct Connect uuid: 69ee618d-be52-468d-bc99-00566f2dd2b9 sellerRegion: us-east-1 authenticationKey: xxxx-xxx-xxxx MCNS2Sp-GCP-Response: value: href: https://api.equinix.com/fabric/v4/connections/4c2c8739-f476-47ae-a0fa-f924e1081e62 type: EVPL_VC uuid: 4c2c8739-f476-47ae-a0fa-f924e1081e62 name: My-MCNS2GCP-Connection operation: providerStatus: PROVISIONING equinixStatus: PROVISIONING order: billingTier: Up to 50 MB notifications: - type: ALL emails: - fabric@gmail.com changeLog: createdBy: fabric createdByFullName: fabric createdByEmail: fabric@gmail.com createdDateTime: 2024-09-06T19:25:09.527Z updatedBy: fabric updatedByFullName: fabric updatedByEmail: fabric@gmail.com updatedDateTime: 2024-09-06T19:25:09.527Z bandwidth: 50 redundancy: group: 33286a70-e0d5-466b-873e-f2c1836d1f0c priority: PRIMARY aSide: accessPoint: type: VPIC_INTERFACE vpicInterface: uuid: cd67f685-41b0-1b07-6de0-0320a5c00abe zSide: accessPoint: location: metroHref: https://api.corp.equinix.com/fabric/v4/metros/DC metroCode: DC profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/bd4570e2-d792-4a00-87f5-3bde040cdcd7 type: L2_PROFILE name: Google Cloud Partner Interconnect Zone 1 uuid: bd4570e2-d792-4a00-87f5-3bde040cdcd7 sellerRegion: us-east1 authenticationKey: xxxx-xxx-xxxx MCNS2Sp-IBM2-Response: value: href: https://api.equinix.com/fabric/v4/connections/d9e3f826-71e4-40a5-9e27-6030d1498e13 type: EVPL_VC uuid: d9e3f826-71e4-40a5-9e27-6030d1498e13 name: MY-MCNS2IBM2-Connection operation: providerStatus: PROVISIONING equinixStatus: PROVISIONING order: billingTier: Up to 50 MB notifications: - type: ALL emails: - fabric@gmail.com changeLog: createdBy: fabric createdByFullName: fabric createdByEmail: fabric@gmail.com createdDateTime: 2024-09-07T05:23:43.711Z updatedBy: fabric updatedByFullName: fabric updatedByEmail: fabric@gmail.com updatedDateTime: 2024-09-07T05:23:43.711Z bandwidth: 50 redundancy: group: f65c252c-ea74-4a12-87aa-7bc0236cb24a priority: PRIMARY aSide: accessPoint: type: VPIC_INTERFACE vpicInterface: uuid: cd67f685-41b0-1b07-6de0-0320a5c00abe zSide: accessPoint: location: metroHref: https://api.corp.equinix.com/fabric/v4/metros/DC metroCode: DC profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/e092ed47-63d2-4f4a-87a0-82e3b08eefe5 type: L2_PROFILE name: IBM Cloud Direct Link 2 uuid: e092ed47-63d2-4f4a-87a0-82e3b08eefe5 sellerRegion: Washington 2 authenticationKey: xxxx-xxx-xxxx MCNS2Sp-Azure-Response: value: href: https://api.equinix.com/fabric/v4/connections/43504d46-f5ce-4d47-99f6-d220df13f81d type: EVPL_VC uuid: 43504d46-f5ce-4d47-99f6-d220df13f81d name: My-MCNS2Azure-Connection operation: providerStatus: PROVISIONING equinixStatus: PROVISIONING order: billingTier: Up to 50 MB notifications: - type: ALL emails: - fabric@gmail.com changeLog: createdBy: fabric createdByFullName: fabric createdByEmail: fabric@gmail.com createdDateTime: 2024-09-07T04:41:43.111Z updatedBy: fabric updatedByFullName: fabric updatedByEmail: fabric@gmail.com updatedDateTime: 2024-09-07T04:41:43.111Z bandwidth: 50 redundancy: group: d88b8fe3-23ac-42b6-8c28-33d33f0b9760 priority: PRIMARY aSide: accessPoint: type: VPIC_INTERFACE vpicInterface: uuid: cd67f685-41b0-1b07-6de0-0320a5c00abe zSide: accessPoint: location: metroHref: https://api.corp.equinix.com/fabric/v4/metros/DC metroCode: DC profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/a1390b22-bbe0-4e93-ad37-85beef9d254d type: L2_PROFILE name: Azure ExpressRoute uuid: a1390b22-bbe0-4e93-ad37-85beef9d254d authenticationKey: xxxx-xxx-xxxx MCNS2Sp-OCI-Response: value: href: https://api.equinix.com/fabric/v4/connections/addae6f7-69c1-494e-905a-3d94b8cb8f1a type: EVPL_VC uuid: addae6f7-69c1-494e-905a-3d94b8cb8f1a name: My-MCNS2OCI-Connection operation: providerStatus: PROVISIONING equinixStatus: PROVISIONING order: billingTier: Up to 50 MB notifications: - type: ALL emails: - fabric@gmail.com changeLog: createdBy: fabric createdByFullName: fabric createdByEmail: fabric@gmail.com createdDateTime: 2024-09-07T05:09:26.587Z updatedBy: fabric updatedByFullName: fabric updatedByEmail: fabric@gmail.com updatedDateTime: 2024-09-07T05:09:26.587Z bandwidth: 50 redundancy: group: 6620b2a3-d3d7-420b-a3a0-4b5ae8b0cd10 priority: PRIMARY aSide: accessPoint: type: VPIC_INTERFACE vpicInterface: uuid: cd67f685-41b0-1b07-6de0-0320a5c00abe zSide: accessPoint: location: metroHref: https://api.corp.equinix.com/fabric/v4/metros/DC metroCode: DC profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/60ef0382-cdaa-44e7-bd36-b803731816b8 type: L2_PROFILE name: Oracle Cloud Infrastructure FastConnect uuid: 60ef0382-cdaa-44e7-bd36-b803731816b8 sellerRegion: us-ashburn-1 authenticationKey: xxxx-xxx-xxxx COLO2NETWORKwithDot1q-Response: value: type: EVPLAN_VC href: https://api.equinix.com/fabric/v4/connections/f3dd7395-7196-45f4-9b6f-54094aa75f53 uuid: f3dd7395-7196-45f4-9b6f-54094aa75f53 name: colo2network-evplan-vc operation: providerStatus: NOT_AVAILABLE equinixStatus: PROVISIONING order: purchaseOrderNumber: 1-129105284100 billingTier: Up to 50 MB notifications: - type: ALL emails: - fabric@equinix.com changeLog: createdBy: fabric createdByFullName: fabric createdByEmail: fabric@equinix.com createdDateTime: 2024-04-23T02:51:07.675Z updatedBy: fabric updatedByFullName: fabric updatedByEmail: fabric@equinix.com updatedDateTime: 2024-04-23T02:51:07.675Z bandwidth: 50 redundancy: group: ecebee55-975b-4017-857c-74617f821b87 priority: PRIMARY aSide: accessPoint: location: metroCode: DA port: type: XF_PORT href: https://api.equinix.com/fabric/v4/ports/9127bb72-5f4f-4517-be74-3af7ce612687 uuid: 9127bb72-5f4f-4517-be74-3af7ce612687 name: 1-DA1-port linkProtocol: type: DOT1Q vlanTag: 307 zSide: accessPoint: network: href: https://api.equinix.com/fabric/v4/networks/25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 uuid: 25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 name: EVPLAN-GLOBAL platformUuid: afe28606-8021-4161-802c-b80d4bc22f20 state: ACTIVE type: EVPLAN scope: GLOBAL location: null COLO2NETWORKwithDot1qAndTerms-Response: value: type: EVPLAN_VC href: https://api.equinix.com/fabric/v4/connections/f3dd7395-7196-45f4-9b6f-54094aa75f53 uuid: f3dd7395-7196-45f4-9b6f-54094aa75f53 name: colo2network-evplan-vc operation: providerStatus: NOT_AVAILABLE equinixStatus: PROVISIONING order: purchaseOrderNumber: 1-129105284100 billingTier: Up to 50 MB termLength: 24 notifications: - type: ALL emails: - fabric@equinix.com changeLog: createdBy: fabric createdByFullName: fabric createdByEmail: fabric@equinix.com createdDateTime: 2024-04-23T02:51:07.675Z updatedBy: fabric updatedByFullName: fabric updatedByEmail: fabric@equinix.com updatedDateTime: 2024-04-23T02:51:07.675Z bandwidth: 50 redundancy: group: ecebee55-975b-4017-857c-74617f821b87 priority: PRIMARY aSide: accessPoint: location: metroCode: DA port: type: XF_PORT href: https://api.equinix.com/fabric/v4/ports/9127bb72-5f4f-4517-be74-3af7ce612687 uuid: 9127bb72-5f4f-4517-be74-3af7ce612687 name: 1-DA1-port linkProtocol: type: DOT1Q vlanTag: 307 zSide: accessPoint: network: href: https://api.equinix.com/fabric/v4/networks/25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 uuid: 25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 name: EVPLAN-GLOBAL platformUuid: afe28606-8021-4161-802c-b80d4bc22f20 state: ACTIVE type: EVPLAN scope: GLOBAL location: null COLO2NETWORKwithEPL-Response: value: type: EPLAN_VC href: https://api.equinix.com/fabric/v4/connections/cce170c5-a496-4928-8426-507e00818887 uuid: cce170c5-a496-4928-8426-507e00818887 name: colo2network-eplan-vc operation: providerStatus: NOT_AVAILABLE equinixStatus: PROVISIONING order: purchaseOrderNumber: 1-129105284100 billingTier: Up to 50 MB notifications: - type: ALL emails: - fabric@test.com changeLog: createdBy: fabric createdByFullName: fabric createdByEmail: fabric@equinix.com createdDateTime: 2024-04-23T03:07:17.587Z updatedBy: fabric updatedByFullName: fabric updatedByEmail: fabric@equinix.com updatedDateTime: 2024-04-23T03:07:17.587Z bandwidth: 50 redundancy: group: dbab0e00-db97-4abf-aebe-76c7a40a371e priority: PRIMARY aSide: accessPoint: location: metroCode: SP port: type: XF_PORT href: https://api.equinix.com/fabric/v4/ports/9127bb72-5f4f-4517-be74-3af7ce612687 uuid: 9127bb72-5f4f-4517-be74-3af7ce612687 name: 505783-port linkProtocol: type: UNTAGGED zSide: accessPoint: network: href: https://api.equinix.com/fabric/v4/networks/25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 uuid: 25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 name: EPLAN-GLOBAL platformUuid: 8abb8305-258b-4690-9b49-714962591add state: ACTIVE type: EPLAN scope: GLOBAL location: null COLO2NETWORKwithEPLAndTerms-Response: value: type: EPLAN_VC href: https://api.equinix.com/fabric/v4/connections/cce170c5-a496-4928-8426-507e00818887 uuid: cce170c5-a496-4928-8426-507e00818887 name: colo2network-eplan-vc operation: providerStatus: NOT_AVAILABLE equinixStatus: PROVISIONING order: purchaseOrderNumber: 1-129105284100 billingTier: Up to 50 MB termLength: 12 notifications: - type: ALL emails: - fabric@test.com changeLog: createdBy: fabric createdByFullName: fabric createdByEmail: fabric@equinix.com createdDateTime: 2024-04-23T03:07:17.587Z updatedBy: fabric updatedByFullName: fabric updatedByEmail: fabric@equinix.com updatedDateTime: 2024-04-23T03:07:17.587Z bandwidth: 50 redundancy: group: dbab0e00-db97-4abf-aebe-76c7a40a371e priority: PRIMARY aSide: accessPoint: location: metroCode: SP port: type: XF_PORT href: https://api.equinix.com/fabric/v4/ports/9127bb72-5f4f-4517-be74-3af7ce612687 uuid: 9127bb72-5f4f-4517-be74-3af7ce612687 name: 505783-port linkProtocol: type: UNTAGGED zSide: accessPoint: network: href: https://api.equinix.com/fabric/v4/networks/25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 uuid: 25f8884e-85e3-4eaa-8ea9-a7ad2ca5b3c2 name: EPLAN-GLOBAL platformUuid: 8abb8305-258b-4690-9b49-714962591add state: ACTIVE type: EPLAN scope: GLOBAL location: null Vd2IAProfile-Response: value: type: IA_VC href: https://uatapi.npclouda.equinix.com/fabric/v4/connections/ce42ca81-538d-4f38-b020-d45fb48d20c7 uuid: ce42ca81-538d-4f38-b020-d45fb48d20c7 name: vd2eia-connection-1 operation: providerStatus: NOT_AVAILABLE equinixStatus: PROVISIONING order: billingTier: Up to 50 MB notifications: - type: ALL emails: - fabric@equinix.com changeLog: createdBy: fabric createdByFullName: fabric createdByEmail: fabric@equinix.com createdDateTime: 2024-04-30T20:19:44.279Z updatedBy: fabric updatedByFullName: fabric updatedByEmail: fabric@equinix.com updatedDateTime: 2024-04-30T20:19:44.279Z bandwidth: 50 redundancy: group: 90720112-3f61-4b74-b854-b948dabd05ca priority: PRIMARY aSide: accessPoint: interface: uuid: 5c226d15-4815-4a85-a83a-6dea1ab220d5 id: 16 type: CLOUD location: metroCode: SY virtualDevice: uuid: d127592c-9094-43c0-9367-27596a231867 type: EDGE zSide: accessPoint: location: metroCode: SY profile: href: https://uatapi.npclouda.equinix.com/fabric/v4/serviceProfiles/32d81829-0bf8-45d5-84e2-7289a553dbb6 type: IA_PROFILE name: Equinix Internet Access uuid: 32d81829-0bf8-45d5-84e2-7289a553dbb6 Vd2NETWORK-Response: value: type: EVPLAN_VC href: https://api.equinix.com/fabric/v4/connections/e1f165fd-29bb-4c15-8ec7-56242677e6fc uuid: e1f165fd-29bb-4c15-8ec7-56242677e6fc name: vd2network-connection operation: providerStatus: NOT_AVAILABLE equinixStatus: PROVISIONING order: purchaseOrderNumber: 1-1234567890 billingTier: Up to 50 MB notifications: - type: ALL emails: - fabric@equinix.com changeLog: createdBy: fabric createdByFullName: fabric createdByEmail: fabric@equinix.com createdDateTime: 2024-04-23T02:12:20.334Z updatedBy: fabric updatedByFullName: fabric updatedByEmail: fabric@equinix.com updatedDateTime: 2024-04-23T02:12:20.334Z bandwidth: 50 redundancy: group: daaaa2be-01ff-4009-9a97-da77562041db priority: PRIMARY aSide: accessPoint: interface: uuid: a4c60de7-09b2-4237-b831-4849d7dd3d92 id: 5 type: CLOUD location: metroCode: DC virtualDevice: uuid: e99ec19c-0939-4c47-bfc1-ff94f99ccc75 type: EDGE zSide: accessPoint: network: href: https://api.equinix.com/fabric/v4/networks/05eeb1d2-5b82-4c9b-9eb9-496085ce8bb2 uuid: 05eeb1d2-5b82-4c9b-9eb9-496085ce8bb2 name: EVPLAN-GLOBAL-1 platformUuid: afe28606-8021-4161-802c-b80d4bc22f20 state: ACTIVE type: EVPLAN scope: GLOBAL location: null Vd2AwsSP-Response: value: type: EVPL_VC href: https://api.equinix.com/fabric/v4/connections/f0a954e7-bdc5-4727-90cc-869f990e289f uuid: f0a954e7-bdc5-4727-90cc-869f990e289f name: vd2aws-connection-1 operation: providerStatus: PROVISIONING equinixStatus: PROVISIONING order: purchaseOrderNumber: 1-1234567890 billingTier: Up to 50 MB notifications: - type: ALL emails: - fabric@equinix.com changeLog: createdBy: fabric createdByFullName: fabric createdByEmail: fabric@equinix.com createdDateTime: 2024-04-27T00:32:21.879Z updatedBy: fabric updatedByFullName: fabric updatedByEmail: fabric@equinix.com updatedDateTime: 2024-04-27T00:32:21.879Z bandwidth: 50 redundancy: group: 1dfd9c4b-58c6-4d96-aebf-eb32a09f031a priority: PRIMARY aSide: accessPoint: interface: uuid: 1b046630-8572-4975-abd0-82c31adf6ec1 id: 4 type: CLOUD location: metroCode: DC virtualDevice: uuid: e16136fd-05ef-49dd-ab98-9f8e619619e9 type: EDGE zSide: accessPoint: location: metroCode: SV profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/69ee618d-be52-468d-bc99-00566f2dd2b9 type: L2_PROFILE name: AWS Direct Connect uuid: 69ee618d-be52-468d-bc99-00566f2dd2b9 sellerRegion: us-west-1 authenticationKey: xxxx-xxx-xxx Vd2AzureSP-Response: value: type: EVPL_VC href: https://api.equinix.com/fabric/v4/connections/3da14bba-d81c-4497-93c3-3f4a3cb0bc40 uuid: 3da14bba-d81c-4497-93c3-3f4a3cb0bc40 name: vd2azure-connection-1 operation: providerStatus: PROVISIONING equinixStatus: PROVISIONING order: purchaseOrderNumber: 1-1234567890 billingTier: Up to 200 MB notifications: - type: ALL emails: - fabric@equinix.com changeLog: createdBy: fabric createdByFullName: fabric createdByEmail: fabric@equinix.com createdDateTime: 2024-04-25T20:30:24.632Z updatedBy: fabric updatedByFullName: fabric updatedByEmail: fabric@equinix.com updatedDateTime: 2024-04-25T20:30:24.632Z bandwidth: 100 redundancy: group: 6b869af5-3f89-4329-bb41-ec6f6b053cc4 priority: PRIMARY aSide: accessPoint: interface: uuid: 237869e8-4dbd-418f-acac-59ec1ec3bc31 id: 9 type: CLOUD location: metroCode: DC virtualDevice: uuid: e16136fd-05ef-49dd-ab98-9f8e619619e9 type: EDGE zSide: accessPoint: location: metroCode: SV profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/a1390b22-bbe0-4e93-ad37-85beef9d254d type: L2_PROFILE name: Azure ExpressRoute uuid: a1390b22-bbe0-4e93-ad37-85beef9d254d authenticationKey: xxxx-xxx-xxxx Vd2OracleSP-Response: value: type: EVPL_VC href: https://api.equinix.com/fabric/v4/connections/53c89f1a-0be7-44a1-9c03-28059632a72d uuid: 53c89f1a-0be7-44a1-9c03-28059632a72d name: vd2oracle-connection-1 operation: providerStatus: PROVISIONING equinixStatus: PROVISIONING order: purchaseOrderNumber: 1-129105284100 billingTier: Up to 1G notifications: - type: ALL emails: - fabric@equinix.com changeLog: createdBy: fabric createdByFullName: fabric createdByEmail: fabric@equinix.com createdDateTime: 2024-04-25T20:40:40.676Z updatedBy: fabric updatedByFullName: fabric updatedByEmail: fabric@equinix.com updatedDateTime: 2024-04-25T20:40:40.677Z bandwidth: 1000 redundancy: group: 43009a55-87ee-4dff-8ae4-70ccb7c3d4e9 priority: PRIMARY aSide: accessPoint: interface: uuid: ca838fd7-74cc-4786-94f4-69405671d0e4 id: 5 type: CLOUD location: metroCode: DC virtualDevice: uuid: e16136fd-05ef-49dd-ab98-9f8e619619e9 type: EDGE zSide: accessPoint: location: metroCode: DC profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/60ef0382-cdaa-44e7-bd36-b803731816b8 type: L2_PROFILE name: Oracle Cloud Infrastructure FastConnect uuid: 60ef0382-cdaa-44e7-bd36-b803731816b8 sellerRegion: us-ashburn-1 authenticationKey: ocid1.virtualcircuit.oc1 Vd2AlibabaSP-Response: value: type: EVPL_VC href: https://api.equinix.com/fabric/v4/connections/66ed4e8a-584c-4027-9788-748fecb5ce35 uuid: 66ed4e8a-584c-4027-9788-748fecb5ce35 name: vd2alibaba-connection-1 operation: providerStatus: PROVISIONING equinixStatus: PROVISIONING order: billingTier: Up to 50 MB notifications: - type: ALL emails: - fabric@equinix.com changeLog: createdBy: fabric createdByFullName: fabric createdByEmail: fabric@equinix.com createdDateTime: 2024-04-25T20:43:43.199Z updatedBy: fabric updatedByFullName: fabric updatedByEmail: fabric@equinix.com updatedDateTime: 2024-04-25T20:43:43.199Z bandwidth: 50 redundancy: group: 160e06b5-cd42-4c2c-b674-6dcda54da4d8 priority: PRIMARY aSide: accessPoint: interface: uuid: 9a76f1c3-948a-4004-8185-d6b49969aefc id: 6 type: CLOUD location: metroCode: DC virtualDevice: uuid: e16136fd-05ef-49dd-ab98-9f8e619619e9 type: EDGE zSide: accessPoint: location: metroCode: SV profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/4c4b8edf-873b-4c6c-805a-edb2c335bd6c type: L2_PROFILE name: Alibaba Cloud Express Connect uuid: 4c4b8edf-873b-4c6c-805a-edb2c335bd6c sellerRegion: us-west-1 authenticationKey: xxxx-xxx-xxxx Vd2GoogleSP-Response: value: type: EVPL_VC href: https://api.equinix.com/fabric/v4/connections/50ae793c-b466-4d71-9724-c32b5e402bbe uuid: 50ae793c-b466-4d71-9724-c32b5e402bbe name: vd2googleSp-connection-1 operation: providerStatus: PROVISIONING equinixStatus: PROVISIONING order: purchaseOrderNumber: 1-1234567890 billingTier: Up to 50 MB notifications: - type: ALL emails: - fabric@equinx.com changeLog: createdBy: fabric createdByFullName: fabric createdByEmail: fabric@equinx.com createdDateTime: 2024-04-25T14:06:48.933Z updatedBy: fabric updatedByFullName: fabric updatedByEmail: fabric@equinx.com updatedDateTime: 2024-04-25T14:06:48.933Z bandwidth: 50 redundancy: group: bd03b85b-18c9-4a80-b589-727d232077d2 priority: PRIMARY aSide: accessPoint: interface: uuid: 3520bc9a-d7e6-440b-9196-656beb54b300 id: 7 type: CLOUD location: metroCode: DC virtualDevice: uuid: e99ec19c-0939-4c47-bfc1-ff94f99ccc75 type: EDGE zSide: accessPoint: location: metroCode: SV profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/bd4570e2-d792-4a00-87f5-3bde040cdcd7 type: L2_PROFILE name: Google Cloud Partner Interconnect Zone 1 uuid: bd4570e2-d792-4a00-87f5-3bde040cdcd7 sellerRegion: us-west2 authenticationKey: xxxx-xxxx/us-west2/1 400_dry_run: value: - errorCode: EQ-3142411 errorMessage: Dry run is not supported for this connection type correlationId: 1012536-0000-108258589231-api additionalInfo: - reason: queryParam:dryRun createBulkGeneric: value: data: - type: EVPL_VC name: Conn-1 order: purchaseOrderNumber: 1-129105284100 bandwidth: 100 redundancy: group: j167f685-41b0-1b07-6de0-320a5c00abie priority: PRIMARY aSide: accessPoint: type: COLO port: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d linkProtocol: type: DOT1Q vlanTag: 1001 zSide: accessPoint: type: SP profile: uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 location: metroCode: SV notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com - type: EVPL_VC name: Conn-1 order: purchaseOrderNumber: 1-129105284100 bandwidth: 100 redundancy: group: j167f685-41b0-1b07-6de0-320a5c00abie priority: SECONDARY aSide: accessPoint: type: COLO port: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d linkProtocol: type: DOT1Q vlanTag: 1001 zSide: accessPoint: type: SP profile: uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 location: metroCode: SV notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com createBulkNonGeneric: value: data: - type: EVPL_VC name: Conn-1 order: purchaseOrderNumber: 1-129105284100 bandwidth: 100 redundancy: group: j167f685-41b0-1b07-6de0-320a5c00abie priority: PRIMARY aSide: accessPoint: type: COLO port: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d linkProtocol: type: DOT1Q vlanTag: 1001 zSide: accessPoint: type: SP profile: uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 location: metroCode: SV region: us-west-1 authenticationKey: xx-xx-xx peeringType: PRIVATE notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com - type: EVPL_VC name: Conn-1 order: purchaseOrderNumber: 1-129105284100 bandwidth: 100 redundancy: group: j167f685-41b0-1b07-6de0-320a5c00abie priority: SECONDARY aSide: accessPoint: type: COLO port: uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d linkProtocol: type: DOT1Q vlanTag: 1001 zSide: accessPoint: type: SP profile: uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 location: metroCode: SV region: us-west-1 authenticationKey: xx-xx-xx peeringType: PRIVATE notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com Vd2Sp-Redundant: value: data: - type: EVPL_VC name: Conn-1 order: purchaseOrderNumber: 1-129105284100 bandwidth: 100 redundancy: group: j167f685-41b0-1b07-6de0-320a5c00abie priority: PRIMARY aSide: accessPoint: type: VD virtualDevice: type: EDGE uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d interface: type: CLOUD id: 3 zSide: accessPoint: type: SP profile: uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 location: metroCode: SV notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com - type: EVPL_VC name: Conn-1 order: purchaseOrderNumber: 1-129105284100 bandwidth: 100 redundancy: group: j167f685-41b0-1b07-6de0-320a5c00abie priority: SECONDARY aSide: accessPoint: type: VD virtualDevice: type: EDGE uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d interface: type: CLOUD id: 5 zSide: accessPoint: type: SP profile: uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 location: metroCode: SV notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com Vd2Colo-Redundant: value: data: - type: EVPL_VC name: Conn-1 order: purchaseOrderNumber: 1-129105284100 bandwidth: 100 redundancy: group: j167f685-41b0-1b07-6de0-320a5c00abie priority: PRIMARY aSide: accessPoint: type: VD virtualDevice: type: EDGE uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d interface: type: CLOUD id: 3 zSide: accessPoint: type: COLO port: uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 linkProtocol: type: DOT1Q vlanTag: 300 notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com - type: EVPL_VC name: Conn-1 order: purchaseOrderNumber: 1-129105284100 bandwidth: 100 redundancy: group: j167f685-41b0-1b07-6de0-320a5c00abie priority: SECONDARY aSide: accessPoint: type: VD virtualDevice: type: EDGE uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d interface: type: CLOUD id: 5 zSide: accessPoint: type: COLO port: uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 linkProtocol: type: DOT1Q vlanTag: 300 notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com Vd2ColoUntagged-Redundant: value: data: - type: EVPL_VC name: Conn-1 order: purchaseOrderNumber: 1-129105284100 bandwidth: 100 redundancy: group: j167f685-41b0-1b07-6de0-320a5c00abie priority: PRIMARY aSide: accessPoint: type: VD virtualDevice: type: EDGE uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d interface: type: CLOUD id: 3 zSide: accessPoint: type: COLO port: uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 linkProtocol: type: UNTAGGED notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com - type: EVPL_VC name: Conn-1 order: purchaseOrderNumber: 1-129105284100 bandwidth: 100 redundancy: group: j167f685-41b0-1b07-6de0-320a5c00abie priority: SECONDARY aSide: accessPoint: type: VD virtualDevice: type: EDGE uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d interface: type: CLOUD id: 5 zSide: accessPoint: type: COLO port: uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 linkProtocol: type: UNTAGGED notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com Vd2ServiceToken-Redundant: value: data: - type: EVPL_VC name: VD2ST-Conn-1 bandwidth: 100 redundancy: priority: PRIMARY aSide: accessPoint: type: VD virtualDevice: type: EDGE uuid: a867f685-41b0-1b07-6de0-320a5c00abdd zSide: serviceToken: uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 notifications: - type: ALL emails: - test@equinix.com - type: EVPL_VC name: VD2ST-Conn-2 bandwidth: 100 redundancy: priority: SECONDARY aSide: accessPoint: type: VD virtualDevice: type: EDGE uuid: b967f685-41b0-1b07-6de0-320a5c00abde zSide: serviceToken: uuid: 10d32a80-0d61-4333-bc03-707b591ae2e6 notifications: - type: ALL emails: - test@equinix.com genericBulkCreateResponse: value: data: - href: https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62 type: EVPL_VC uuid: 3a58dd05-f46d-4b1d-a154-2e85c396ea62 name: My-Layer2-Connection order: purchaseOrderNumber: 1-129105284100 billingTier: Up to 200 MB account: accountNumber: 201246 orgId: 92610 bandwidth: 100 aSide: accessPoint: type: COLO port: href: https://api.equinix.com/fabric/v4/ports/a00cef6f-8e35-4794-9ff9-665e084e4e6d uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d linkProtocol: type: DOT1Q vlanTag: 1001 location: metroHref: https://api.equinix.com/fabric/v4/metros/SV metroCode: SV zSide: accessPoint: type: SP profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/20d32a80-0d61-4333-bc03-707b591ae2f5 type: L2_PROFILE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 location: metroHref: https://api.equinix.com/fabric/v4/metros/SV metroCode: SV notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com operation: equinixStatus: PENDING_APPROVAL providerStatus: NOT_AVAILABLE changeLog: createdDateTime: 2020-05-21T10:30:00Z - href: https://api.equinix.com/fabric/v4/connections/0f58dd05-f46d-4b1d-a154-2e85c396ea30 type: EVPL_VC uuid: 0f58dd05-f46d-4b1d-a154-2e85c396ea30 name: My-Layer2-Connection order: purchaseOrderNumber: 1-129105284100 billingTier: Up to 200 MB account: accountNumber: 201246 orgId: 92610 bandwidth: 100 aSide: accessPoint: type: COLO port: href: https://api.equinix.com/fabric/v4/ports/a00cef6f-8e35-4794-9ff9-665e084e4e6d uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d linkProtocol: type: DOT1Q vlanTag: 1001 location: metroHref: https://api.equinix.com/fabric/v4/metros/SV metroCode: SV zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 location: metroHref: https://api.equinix.com/fabric/v4/metros/SV metroCode: SV notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com operation: equinixStatus: PENDING_APPROVAL providerStatus: NOT_AVAILABLE changeLog: createdDateTime: 2020-05-21T10:30:00Z nonGenericCreateResponse: value: data: - href: https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62 type: EVPL_VC uuid: 3a58dd05-f46d-4b1d-a154-2e85c396ea62 name: My-Layer2-Connection order: purchaseOrderNumber: 1-129105284100 billingTier: Up to 200 MB bandwidth: 100 aSide: accessPoint: type: COLO port: href: https://api.equinix.com/fabric/v4/ports/a00cef6f-8e35-4794-9ff9-665e084e4e6d uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d linkProtocol: type: DOT1Q vlanTag: 1001 location: metroHref: https://api.equinix.com/fabric/v4/metros/SV metroCode: SV zSide: accessPoint: type: SP profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/20d32a80-0d61-4333-bc03-707b591ae2f5 type: L2_PROFILE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 location: metroHref: https://api.equinix.com/fabric/v4/metros/SV metroCode: SV region: us-west-1 authenticationKey: xx-xx-xx peeringType: PRIVATE notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com operation: equinixStatus: PENDING_APPROVAL providerStatus: NOT_AVAILABLE changeLog: createdDateTime: 2020-05-21T10:30:00Z - href: https://api.equinix.com/fabric/v4/connections/0f58dd05-f46d-4b1d-a154-2e85c396ea30 type: EVPL_VC uuid: 0f58dd05-f46d-4b1d-a154-2e85c396ea30 name: My-Layer2-Connection order: purchaseOrderNumber: 1-129105284100 billingTier: Up to 200 MB bandwidth: 100 aSide: accessPoint: type: COLO port: href: https://api.equinix.com/fabric/v4/ports/a00cef6f-8e35-4794-9ff9-665e084e4e6d uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d linkProtocol: type: DOT1Q vlanTag: 1001 location: metroHref: https://api.equinix.com/fabric/v4/metros/SV metroCode: SV zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 location: metroHref: https://api.equinix.com/fabric/v4/metros/SV metroCode: SV region: us-west-1 authenticationKey: xx-xx-xx peeringType: PRIVATE notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com operation: equinixStatus: PENDING_APPROVAL providerStatus: NOT_AVAILABLE changeLog: createdDateTime: 2020-05-21T10:30:00Z Vd2Sp-Redundant-Response: value: data: - href: https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62 type: EVPL_VC uuid: 3a58dd05-f46d-4b1d-a154-2e85c396ea62 name: My-Layer2-Connection order: purchaseOrderNumber: 1-129105284100 billingTier: Up to 200 MB account: accountNumber: 201246 orgId: 92610 bandwidth: 100 aSide: accessPoint: type: VD virtualDevice: type: EDGE uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d interface: type: CLOUD uuid: 95542b34-cf1c-41aa-89f7-590946f9df53 id: 3 linkProtocol: type: DOT1Q vlanTag: 1001 location: metroHref: https://api.equinix.com/fabric/v4/metros/SV metroCode: SV zSide: accessPoint: type: SP profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/20d32a80-0d61-4333-bc03-707b591ae2f5 type: L2_PROFILE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 location: metroCode: SV notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com operation: equinixStatus: PENDING_APPROVAL providerStatus: NOT_AVAILABLE changeLog: createdDateTime: 2020-05-21T10:30:00Z - href: https://api.equinix.com/fabric/v4/connections/0f58dd05-f46d-4b1d-a154-2e85c396ea30 type: EVPL_VC uuid: 0f58dd05-f46d-4b1d-a154-2e85c396ea30 name: My-Layer2-Connection order: purchaseOrderNumber: 1-129105284100 billingTier: Up to 200 MB account: accountNumber: 201246 orgId: 92610 bandwidth: 100 aSide: accessPoint: type: VD virtualDevice: type: EDGE uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d interface: type: CLOUD uuid: 95542b34-cf1c-41aa-89f7-590946f9df53 id: 4 linkProtocol: type: DOT1Q vlanTag: 1001 location: metroCode: SV zSide: accessPoint: type: SP profile: type: L2_PROFILE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 location: metroCode: SV notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com operation: equinixStatus: PENDING_APPROVAL providerStatus: NOT_AVAILABLE changeLog: createdDateTime: 2020-05-21T10:30:00Z Vd2Colo-Redundant-Response: value: data: - href: https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62 type: EVPL_VC uuid: 3a58dd05-f46d-4b1d-a154-2e85c396ea62 name: My-Layer2-Connection order: purchaseOrderNumber: 1-129105284100 billingTier: Up to 200 MB bandwidth: 100 account: accountNumber: 201246 orgId: 92610 aSide: accessPoint: type: VD virtualDevice: type: EDGE uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d interface: type: CLOUD uuid: 95542b34-cf1c-41aa-89f7-590946f9df53 id: 3 linkProtocol: type: DOT1Q vlanTag: 1001 location: metroHref: https://api.equinix.com/fabric/v4/metros/SV metroCode: SV zSide: accessPoint: type: COLO port: href: https://api.equinix.com/fabric/v4/ports/20d32a80-0d61-4333-bc03-707b591ae2f4 type: XF_PORT uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 linkProtocol: type: DOT1Q vlanTag: 300 notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com operation: equinixStatus: PROVISIONING providerStatus: NOT_AVAILABLE changeLog: createdDateTime: 2020-05-21T10:30:00Z - href: https://api.equinix.com/fabric/v4/connections/0f58dd05-f46d-4b1d-a154-2e85c396ea30 type: EVPL_VC uuid: 0f58dd05-f46d-4b1d-a154-2e85c396ea30 name: My-Layer2-Connection order: purchaseOrderNumber: 1-129105284100 billingTier: Up to 200 MB bandwidth: 100 account: accountNumber: 201246 orgId: 92610 aSide: accessPoint: type: VD virtualDevice: type: EDGE uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d interface: type: CLOUD uuid: 95542b34-cf1c-41aa-89f7-590946f9df53 id: 4 linkProtocol: type: DOT1Q vlanTag: 1001 location: metroHref: https://api.equinix.com/fabric/v4/metros/SV metroCode: SV zSide: accessPoint: type: COLO port: type: XF_PORT uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 linkProtocol: type: DOT1Q vlanTag: 300 notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com operation: equinixStatus: PROVISIONING providerStatus: NOT_AVAILABLE changeLog: createdDateTime: 2020-05-21T10:30:00Z Vd2ColoUntagged-Redundant-Response: value: data: - href: https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62 type: EVPL_VC uuid: 3a58dd05-f46d-4b1d-a154-2e85c396ea62 name: My-Layer2-Connection order: purchaseOrderNumber: 1-129105284100 billingTier: Up to 200 MB bandwidth: 100 account: accountNumber: 201246 orgId: 92610 aSide: accessPoint: type: VD virtualDevice: type: EDGE uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d interface: type: CLOUD uuid: 95542b34-cf1c-41aa-89f7-590946f9df53 id: 3 linkProtocol: type: DOT1Q vlanTag: 1001 location: metroHref: https://api.equinix.com/fabric/v4/metros/SV metroCode: SV zSide: accessPoint: type: COLO port: href: https://api.equinix.com/fabric/v4/ports/20d32a80-0d61-4333-bc03-707b591ae2f4 type: XF_PORT uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 linkProtocol: type: UNTAGGED notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com operation: equinixStatus: PROVISIONING providerStatus: NOT_AVAILABLE changeLog: createdDateTime: 2020-05-21T10:30:00Z - href: https://api.equinix.com/fabric/v4/connections/0f58dd05-f46d-4b1d-a154-2e85c396ea30 type: EVPL_VC uuid: 0f58dd05-f46d-4b1d-a154-2e85c396ea30 name: My-Layer2-Connection order: purchaseOrderNumber: 1-129105284100 billingTier: Up to 200 MB bandwidth: 100 account: accountNumber: 201246 orgId: 92610 aSide: accessPoint: type: VD virtualDevice: type: EDGE uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d interface: type: CLOUD uuid: 95542b34-cf1c-41aa-89f7-590946f9df53 id: 4 linkProtocol: type: DOT1Q vlanTag: 1001 location: metroHref: https://api.equinix.com/fabric/v4/metros/SV metroCode: SV zSide: accessPoint: type: COLO port: type: XF_PORT uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 linkProtocol: type: UNTAGGED notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com operation: equinixStatus: PROVISIONING providerStatus: NOT_AVAILABLE changeLog: createdBy: testBuyer createdDateTime: 2020-05-21T10:30:00Z Vd2ServiceToken-Redundant-Response: value: data: - href: https://api.equinix.com/fabric/v4/connections/ebc37e2e-c36b-4e93-86a4-fc4efce7abc8 type: EVPL_VC uuid: ebc37e2e-c36b-4e93-86a4-fc4efce7abc8 name: VD2ST-Conn-1 state: ACTIVE operation: providerStatus: NOT_AVAILABLE equinixStatus: PROVISIONING bandwidth: 50 redundancy: group: 1ba79cfc-e123-4fda-a3ff-f6b460d90299 priority: PRIMARY aSide: accessPoint: interface: uuid: 17060c65-5556-417d-9919-3d9ac59c01b9 id: 5 type: CLOUD location: metroCode: DC linkProtocol: type: DOT1Q vlanTag: 18293 virtualDevice: uuid: a867f685-41b0-1b07-6de0-320a5c00abdd type: EDGE zSide: serviceToken: href: https://api.equinix.com/fabric/v4/serviceTokens/20d32a80-0d61-4333-bc03-707b591ae2f5 uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 accessPoint: location: metroHref: https://api.equinix.com/fabric/v4/metros/DC metroCode: DC port: href: https://api.equinix.com/fabric/v4/ports/20d32a80-0d61-4333-bc03-707b591ae2f4 type: XF_PORT uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 name: testBuyer-DC5-L-Dot1q-STD-PRI-10G-JN-161 linkProtocol: type: DOT1Q vlanTag: 992 order: billingTier: Up to 50 MB notifications: - type: ALL emails: - test@equinix.com changeLog: createdBy: test createdByFullName: test test createdByEmail: test@equinix.com createdDateTime: 2023-03-01T22:57:15.874Z updatedBy: test updatedByFullName: test test updatedByEmail: test@equinix.com updatedDateTime: 2023-03-01T22:57:15.874Z - href: https://api.equinix.com/fabric/v4/connections/d27746b9-6c1e-95cb-b0ee-6c2fdb4990ba type: EVPL_VC uuid: d27746b9-6c1e-95cb-b0ee-6c2fdb4990ba name: VD2ST-Conn-2 state: ACTIVE operation: providerStatus: NOT_AVAILABLE equinixStatus: PROVISIONING bandwidth: 50 redundancy: group: 1ba79cfc-e123-4fda-a3ff-f6b460d90299 priority: SECONDARY aSide: accessPoint: interface: uuid: 1e4cec46-ff5f-4f2a-8f3b-29225600040f id: 4 type: CLOUD location: metroCode: DC linkProtocol: type: DOT1Q vlanTag: 18303 virtualDevice: uuid: b967f685-41b0-1b07-6de0-320a5c00abde type: EDGE zSide: serviceToken: href: https://api.equinix.com/fabric/v4/serviceTokens/10d32a80-0d61-4333-bc03-707b591ae2e6 uuid: 10d32a80-0d61-4333-bc03-707b591ae2e6 accessPoint: location: metroHref: https://api.equinix.com/fabric/v4/metros/DC metroCode: DC port: href: https://api.equinix.com/fabric/v4/ports/d791f8cb-59c8-9c80-8ce0-306a5c00e3ae type: XF_PORT uuid: d791f8cb-59c8-9c80-8ce0-306a5c00e3ae name: testBuyer-DC6-NL-Dot1q-STD-SEC-10G-JN-208 linkProtocol: type: DOT1Q vlanTag: 993 order: billingTier: Up to 50 MB notifications: - type: ALL emails: - test@equinix.com changeLog: createdBy: test createdByFullName: test test createdByEmail: test@equinix.com createdDateTime: 2023-03-01T22:57:15.918Z updatedBy: test updatedByFullName: test test updatedByEmail: test@equinix.com updatedDateTime: 2023-03-01T22:57:15.918Z ConnectionBulkMigrationRequest: value: - op: replace path: /aSide/accessPoint/port/uuid value: c791f8cb-594a-94a0-8ce0-306a5c00a4ee ConnectionBulkMigrationResponse: value: data: - href: https://api.equinix.com/fabric/v4/connections/347832b4-61f5-4f9e-b5f3-e57dcbb8e95b uuid: 347832b4-61f5-4f9e-b5f3-e57dcbb8e95b type: EVPL_VC name: aSide_vcBulk_p2p_04 bandwidth: 5 redundancy: group: 3491b0b6-811b-4e33-a4f3-494f1b91f27d priority: PRIMARY order: purchaseOrderNumber: PO1234567 billingTier: Up to 50 MB notifications: - type: ALL emails: - testBuyer@equinix.com aSide: accessPoint: port: href: https://api.equinix.com/fabric/v4/ports/c791f8cb-594a-94a0-8ce0-306a5c00a4ee uuid: c791f8cb-594a-94a0-8ce0-306a5c00a4ee name: testBuyer-SV5-L-Dot1q-STD-PRI-10G-NK-82 type: XF_PORT linkProtocol: type: DOT1Q vlanTag: 2 location: metroHref: https://api.equinix.com/fabric/v4/metros/SV metroCode: SV zSide: accessPoint: port: href: https://api.equinix.com/fabric/v4/ports/c791f8cb-599c-99c0-8ce0-306a5c00a4ee uuid: c791f8cb-599c-99c0-8ce0-306a5c00a4ee name: testBuyer-DC5-NL-Dot1q-STD-PRI-10G-JN-164 type: XF_PORT linkProtocol: type: DOT1Q vlanTag: 1117 location: metroHref: https://api.equinix.com/fabric/v4/metros/DC metroCode: DC operation: equinixStatus: PROVISIONED providerStatus: AVAILABLE changeLog: createdBy: testBuyer createdDateTime: 2021-12-02 07:17:41.663 createdByFullName: testBuyer testBuyer createdByEmail: testBuyer@equinix.com updatedBy: testBuyer updatedDateTime: 2021-12-02 07:17:41.663 updatedByFullName: testBuyer testBuyer updatedByEmail: testBuyer@equinix.com change: uuid: 2f395804-c197-4796-b7b3-359d5fa5d853 type: CONNECTION_UPDATE status: APPROVED createdDateTime: 2021-12-06 22:11:18.616 data: op: replace path: /aSide/accessPoint/port/uuid value: c791f8cb-58fb-8fb0-8ce0-306a5c00a4ee NonGenericConnectionResponseExample: value: href: https://api.equinix.com/fabric/v4/connections/462ad0bb-7fe2-41b1-8d1a-c62494e0c7e3 type: EVPL_VC uuid: 462ad0bb-7fe2-41b1-8d1a-c62494e0c7e3 name: E2E-CON-280122031843987 state: DEPROVISIONED operation: providerStatus: FAILED equinixStatus: DEPROVISIONED order: purchaseOrderNumber: PO608540135268 notifications: - type: ALL emails: - fake@mail.com account: accountNumber: 270001 orgId: 91997 globalOrgId: 0016u000003JZ4sAAG changeLog: createdBy: testBuyer createdDateTime: 2022-01-28T03:18:48.908Z bandwidth: 50 redundancy: group: 50ba51bb-085d-4084-ac38-c31860ca5f4d priority: PRIMARY isRemote: false direction: OUTGOING aSide: accessPoint: type: COLO location: metroHref: https://api.equinix.com/fabric/v4/metros/SV metroCode: SV port: href: https://api.equinix.com/fabric/v4/ports/c791f8cb-594b-94b0-8ce0-306a5c00a4ee uuid: c791f8cb-594b-94b0-8ce0-306a5c00a4ee name: testBuyer-SV5-NL-Dot1q-BO-PRI-10G-NK-83 linkProtocol: type: DOT1Q vlanTag: 2628 zSide: accessPoint: type: SP location: metroHref: https://api.equinix.com/fabric/v4/metros/SV metroCode: SV profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/063f4b0f-2d5b-4db7-95da-d9eddfc92602 type: L2_PROFILE name: Google Cloud Partner Interconnect Zone 1 uuid: 063f4b0f-2d5b-4db7-95da-d9eddfc92602 linkProtocol: type: DOT1Q sellerRegion: us-west1 authenticationKey: xx-xxx-xx-xxxxx/xxx/x GenericConnectionResponseExample: value: href: https://api.equinix.com/fabric/v4/connections/650fa2db-37fc-4eca-a9ac-1bb33481b03f type: EVPL_VC uuid: 650fa2db-37fc-4eca-a9ac-1bb33481b03f name: E2E-CON-280122023234849 state: PROVISIONED operation: providerStatus: AVAILABLE equinixStatus: PROVISIONED order: purchaseOrderNumber: PO754587184643 notifications: - type: ALL emails: - fake@mail.com account: accountNumber: 270001 orgId: 91997 globalOrgId: 0016u000003JZ4sAAG changeLog: createdBy: testBuyer createdDateTime: 2022-01-28T02:32:36.402Z bandwidth: 50 redundancy: group: 4647f20d-6339-4e83-b31e-b35da3060d63 priority: PRIMARY isRemote: false direction: OUTGOING aSide: accessPoint: type: COLO location: metroHref: https://api.equinix.com/fabric/v4/metros/DA metroCode: DA port: href: https://api.equinix.com/fabric/v4/ports/c791f8cb-5a41-a410-8ce0-306a5c00a4ee uuid: c791f8cb-5a41-a410-8ce0-306a5c00a4ee name: testBuyer-DA1-L-Dot1q-STD-PRI-10G-NK-329 linkProtocol: type: DOT1Q vlanTag: 1043 zSide: accessPoint: type: SP location: metroHref: https://api.equinix.com/fabric/v4/metros/DA metroCode: DA port: href: https://api.equinix.com/fabric/v4/ports/c791f8cb-5a49-a490-8ce0-306a5c00a4ee uuid: c791f8cb-5a49-a490-8ce0-306a5c00a4ee name: testSeller-DA1-L-Dot1q-STD-PRI-10G-NK-337 profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/32fd70f2-ce6b-4140-9358-561db52f2ea0 type: L2_PROFILE name: SP for Local No-Redundant Connection DOT1Q uuid: 32fd70f2-ce6b-4140-9358-561db52f2ea0 linkProtocol: type: DOT1Q vlanTag: 3322 400_Invalid_id: value: - errorCode: EQ-3142519 errorMessage: Connection does not exist or do not belong to user,Please check connection Id correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec ConnectionPutCustomFieldsRequest: value: additionalInfo: - key: Text Custom Field value: Test Custom Field - key: Number Custom Field value: "123" - key: Optional List Filed value: Option 1 - key: Check Box Custom Filed value: true zSide: accessPoint: type: SP location: metroCode: SV profile: type: L2_PROFILE uuid: ab068089-1b76-484e-b0f7-80e13abd6920 aSide: accessPoint: type: COLO linkProtocol: type: Dot1q vlanTag: "23" location: metroCode: DA port: uuid: c791f8cb-59f1-9f10-8ce0-306a5c00a4ee bandwidth: 50 name: CONNECTION_TESTING notifications: - type: ALL emails: - fusiontestbuyer@equinix.com type: EVPL_VC uuid: 92d54857-fe28-4977-8fca-54e7bef67bba order: purchaseOrderNumber: POTEST1 ConnectionDeletionResponse: value: href: https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62 type: EVPL_VC uuid: 3a58dd05-f46d-4b1d-a154-2e85c396ea62 name: My-Layer2-Connection order: purchaseOrderNumber: 1-129105284100 billingTier: Up to 200 MB /*Proposal*/ bandwidth: 100 aSide: accessPoint: type: COLO port: href: https://api.equinix.com/fabric/v4/ports/a00cef6f-8e35-4794-9ff9-665e084e4e6d type: XF_PORT uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d linkProtocol: type: DOT1Q vlanTag: 1001 location: metroHref: https://api.equinix.com/fabric/v4/metros/SV metroCode: SV zSide: accessPoint: type: SP profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/20d32a80-0d61-4333-bc03-707b591ae2f5 type: L2_PROFILE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 port: href: https://api.equinix.com/fabric/v4/ports/20d32a80-0d61-4333-bc03-707b591ae2f4 type: XF_PORT uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 linkProtocol: type: QINQ vlanSTag: 1002 vlanCTag: 1001 location: metroHref: https://api.equinix.com/fabric/v4/metros/SV metroCode: SV notifications: - type: ALL emails: - test@equinix.com - test1@equinix.com operation: equinixStatus: DEPROVISIONING providerStatus: DEPROVISIONING changeLog: createdDateTime: 2020-05-21T10:30:00Z updatedDateTime: 2020-05-21T10:30:00Z deletedDateTime: 2020-05-21T10:30:00Z createdBy: 232216 updatedBy: 344339 deletedBy: 232216 400-delete: value: - errorCode: EQ-3142510 errorMessage: Connection is in transient state correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec 403-delete: value: - errorCode: EQ-3142401 errorMessage: Your account isn't authorized to perform this task. Contact your administrator for assistance. correlationId: 12312y7127tges ConnectionUpdateNameRequest: value: - op: replace path: /name value: Conn-Name-2 ConnectionUpdateBandwidthRequest: value: - op: replace path: /bandwidth value: 1000 ConnectionAddAccessAndSecretKeyAWSRequest: value: - op: add path: "" value: additionalInfo: - key: accessKey value: nTTgtgoQbTQCRHTbynll - key: secretKey value: NwPcpbWgFEPofydsZEQGwjtHqJOYrUmBbrcxtOzP ConnectionMigrationAsideRequest: value: - op: replace path: /aSide/accessPoint/port/uuid value: 5e7fd31d-f1e8-46fe-b6ad-6f5f2306cfd8 ConnectionUpdateNotificationEmailRequest: value: - op: replace path: /notifications value: - type: ALL emails: - testEmail1@equinix.com - testEmail2@equinix.com ConnectionMigrationAsideVirtualDeviceRequest: value: - op: replace path: /aSide/accessPoint value: virtualDevice: type: EDGE uuid: 207667ba-3211-452c-b0a8-8b9046e122a5 interface: type: CLOUD id: 4 ConnectionPatchResponseDryRun: value: href: https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62 type: EVPL_VC uuid: 3a58dd05-f46d-4b1d-a154-2e85c396ea62 name: My-Layer2-Connection-2 bandwidth: 1000 direction: OUTGOING isRemote: true redundancy: group: 66c10a60-789e-4b25-b85c-7eb225a4c344 priority: PRIMARY aSide: accessPoint: type: COLO port: href: https://api.equinix.com/fabric/v4/ports/a00cef6f-8e35-4794-9ff9-665e084e4e6d uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d linkProtocol: type: DOT1Q vlanTag: 1001 zSide: accessPoint: type: SP profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c type: L2_PROFILE location: metroHref: https://api.equinix.com/fabric/v4/metros/MX metroCode: MX linkProtocol: type: DOT1Q vlanTag: 1001 operation: providerStatus: PROVISIONED equinixStatus: PROVISIONED change: type: CONNECTION_UPDATE status: APPROVED createdDateTime: 2021-12-12T06:00:01.183Z data: op: replace path: /aSide/accessPoint/port/uuid value: c791f8cb-58f9-8f90-8ce0-306a5c00a4ee changeLog: createdDateTime: 2020-04-21T10:30:00Z account: accountNumber: 270001 orgId: 91997 globalOrgId: 3453453cccc ConnectionPatchResponse: value: href: https://api.equinix.com/fabric/v4/connections/3a58dd05-f46d-4b1d-a154-2e85c396ea62 type: EVPL_VC uuid: 3a58dd05-f46d-4b1d-a154-2e85c396ea62 name: My-Layer2-Connection-2 bandwidth: 1000 direction: OUTGOING isRemote: true redundancy: group: 66c10a60-789e-4b25-b85c-7eb225a4c344 priority: PRIMARY aSide: accessPoint: type: COLO port: href: https://api.equinix.com/fabric/v4/ports/a00cef6f-8e35-4794-9ff9-665e084e4e6d uuid: a00cef6f-8e35-4794-9ff9-665e084e4e6d linkProtocol: type: DOT1Q vlanTag: 1001 zSide: accessPoint: type: SP profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c type: L2_PROFILE location: metroHref: https://api.equinix.com/fabric/v4/metros/MX metroCode: MX linkProtocol: type: DOT1Q vlanTag: 1001 operation: providerStatus: PROVISIONED equinixStatus: PROVISIONED change: uuid: da6a1a0b-0872-4c06-b9d7-5c8ee3056775 type: CONNECTION_UPDATE status: APPROVED createdDateTime: 2021-12-12T06:00:01.183Z updatedDateTime: 2021-12-12T06:00:09.278916Z data: op: replace path: /aSide/accessPoint/port/uuid value: c791f8cb-58f9-8f90-8ce0-306a5c00a4ee changeLog: createdDateTime: 2020-04-21T10:30:00Z updatedDateTime: 2020-05-21T10:30:00Z account: accountNumber: 270001 orgId: 91997 globalOrgId: 3453453cccc Connection_Creation_Acceptance: value: type: CONNECTION_CREATION_ACCEPTANCE data: zSide: accessPoint: type: COLO port: uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 linkProtocol: type: QINQ vlanSTag: 1002 vlanCTag: 1001 Connection_Creation_Rejection: value: type: CONNECTION_CREATION_REJECTION description: Invalid connection request Connection_Update_Acceptance: value: type: CONNECTION_UPDATE_ACCEPTANCE Connection_Update_Rejection: value: type: CONNECTION_UPDATE_REJECTION description: Invalid connection update request Connection_Deletion_Acceptance: value: type: CONNECTION_DELETION_ACCEPTANCE Connection_Update_Request_VC_Migration: value: type: CONNECTION_UPDATE_REQUEST data: zSide: accessPoint: type: COLO port: uuid: c791f8cb-5a47-a470-8ce0-306a5c00a4ee Connection_Provider_Status_Request: value: type: CONNECTION_PROVIDER_STATUS_REQUEST Connection_Provider_Bandwidth_Request: value: type: CONNECTION_PROVIDER_BANDWIDTH_REQUEST AcceptZSide_NetworkEdge_Request: value: type: CONNECTION_CREATION_ACCEPTANCE data: zSide: accessPoint: virtualDevice: uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 interface: type: CLOUD id: 8 ConnectionActionResponse: value: href: https://api.equinix.com/fabric/v4/connections/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81/actions/37c10edc-ba2e-4240-a850-8a48f9c47d00 type: CONNECTION_CREATION_ACCEPTANCE uuid: 3a58dd05-f46d-4b1d-a154-2e85c396ea62 data: zSide: accessPoint: type: SP profile: href: https://api.equinix.com/fabric/v4/serviceProfiles/22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c uuid: 22d4e853-ef33-4ff0-b5b2-a2b1d5dfa50c type: L2_PROFILE location: metroHref: https://api.equinix.com/fabric/v4/metros/MX metroCode: MX linkProtocol: type: DOT1Q vlanTag: 1001 changeLog: createdDateTime: 2020-04-21T10:30:00Z updatedDateTime: 2020-05-21T10:30:00Z Connection_Provider_Bandwidth_Response: value: href: https://api.equinix.com/fabric/v4/connections/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81/actions/37c10edc-ba2e-4240-a850-8a48f9c47d00 type: CONNECTION_PROVIDER_BANDWIDTH_REQUEST uuid: 3a58dd05-f46d-4b1d-a154-2e85c396ea62 data: providerBandwidth: 500 changeLog: createdDateTime: 2020-04-21T10:30:00Z updatedDateTime: 2020-05-21T10:30:00Z ConnectionRoutesSearchByType: value: filter: and: - property: /type operator: = values: - IPv4_BGP_ROUTE pagination: offset: 0 limit: 20 sort: - direction: DESC property: /changeLog/createdDateTime ConnectionRoutesSearchByState: value: filter: and: - property: /state operator: = values: - ACTIVE pagination: offset: 0 limit: 20 sort: - direction: DESC property: /changeLog/createdDateTime ConnectionRoutesSearchByMed: value: filter: and: - property: /med operator: = values: - 200 pagination: offset: 0 limit: 20 sort: - direction: DESC property: /changeLog/createdDateTime RoutingProtocolGetAll: value: pagination: offset: 0 limit: 20 total: 2 data: - href: https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4 uuid: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 state: PROVISIONING change: uuid: 3c9b8e7a2-f3b1-4576-a4a9-1366a63df170 href: https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4/changes/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170 type: ROUTING_PROTOCOL_CREATION changelog: createdBy: abc@xyz.com createdByFullName: abc createdByEmail: abc@xyz.com createdDateTime: 2021-10-30T07:21:39Z updatedBy: abc@xyz.com updatedByFullName: abc updatedByEmail: abc@xyz.com updatedDateTime: 2021-10-30T07:21:39Z type: BGP bgpIpv4: customerPeerIp: 192.168.100.2 enabled: true outboundASPrependCount: 3 inboundMED: 1000 outboundMED: 2000 routesMax: 40 operation: operationalStatus: UNKNOWN customerAsn: 10000 equinixAsn: 10001 asOverrideEnabled: true - href: https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4 uuid: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 state: PROVISIONING change: uuid: 3c9b8e7a2-f3b1-4576-a4a9-1366a63df170 href: https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4/changes/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170 type: ROUTING_PROTOCOL_CREATION changelog: createdBy: abc@xyz.com createdByFullName: abc createdByEmail: abc@xyz.com createdDateTime: 2021-10-30T07:21:39Z updatedBy: abc@xyz.com updatedByFullName: abc updatedByEmail: abc@xyz.com updatedDateTime: 2021-10-30T07:21:39Z type: DIRECT directIpv4: equinixIfaceIp: 192.168.100.1/30 404_invalid_id: value: - errorCode: EQ-3041120 errorMessage: The connection ID was not found or was already deleted. correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec 500_internal_error: value: - errorCode: EQ-3041011 errorMessage: Bad request - Internal Server Error. Please check the request payload and submit again. details: Please contact support@equinix.com for more info correlationId: 9048796775044a60-39cb-4ccc-b272-b80f126e5408 additionalInfo: - reason: Please contact support@equinix.com for more info Fcr2ColoCreateDirect: value: type: DIRECT directIpv4: equinixIfaceIp: 192.168.100.1/30 directIpv6: equinixIfaceIp: 2001:7a9::34f4:0:f3dd:1/126 Fcr2ColoCreateBGP: value: type: BGP bgpIpv4: customerPeerIp: 10.1.1.2 equinixPeerIp: 192.168.100.1 bgpIpv6: customerPeerIp: 2001:db8:c59b::1 equinixPeerIp: 2001:db8:c59b::1 outboundASPrependCount: 3 customerAsn: 100 bfd: enabled: true interval: 100 Fcr2GcpCreateDirect: value: type: DIRECT directIpv4: equinixIfaceIp: 169.254.100.1/30 Fcr2GcpCreateBGP: value: type: BGP bgpIpv4: customerPeerIp: 169.254.100.2 equinixPeerIp: 169.254.100.1 outboundASPrependCount: 3 customerAsn: 100 RoutingProtocolCreateBGPResponse: value: href: https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4 uuid: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 state: PROVISIONING change: href: https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4/changes/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170 uuid: 3c9b8e7a2-f3b1-4576-a4a9-1366a63df170 type: ROUTING_PROTOCOL_CREATION changelog: createdBy: abc@xyz.com createdByFullName: abc createdByEmail: abc@xyz.com createdDateTime: 2021-10-30T07:21:39Z updatedBy: abc@xyz.com updatedByFullName: abc updatedByEmail: abc@xyz.com updatedDateTime: 2021-10-30T07:21:39Z type: BGP bgpIpv4: customerPeerIp: 10.1.1.3 enabled: true outboundASPrependCount: 3 inboundMED: 1000 outboundMED: 2000 routesMax: 40 operation: operationalStatus: UNKNOWN customerAsn: 10000 equinixAsn: 10001 asOverrideEnabled: true RoutingProtocolCreateDirectResponse: value: href: https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4 uuid: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 state: PROVISIONING change: uuid: 3c9b8e7a2-f3b1-4576-a4a9-1366a63df170 href: https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4/changes/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170 type: ROUTING_PROTOCOL_CREATION changelog: createdBy: abc@xyz.com createdByFullName: abc createdByEmail: abc@xyz.com createdDateTime: 2021-10-30T07:21:39Z updatedBy: abc@xyz.com updatedByFullName: abc updatedByEmail: abc@xyz.com updatedDateTime: 2021-10-30T07:21:39Z type: DIRECT directIpv4: equinixIfaceIp: 192.168.100.1/30 CreateRoutingWithDirectOnly: value: data: - type: DIRECT directIpv4: equinixIfaceIp: 192.168.100.1/30 directIpv6: equinixIfaceIp: 2001:7a9::34f4:0:f3dd:1/126 CreateRoutingWithBGPOnly: value: data: - type: BGP bgpIpv4: customerPeerIp: 10.1.1.2 equinixPeerIp: 192.168.100.1 outboundASPrependCount: 3 inboundMED: 1000 outboundMED: 2000 bgpIpv6: customerPeerIp: 2001:db8:c59b::2 equinixPeerIp: 2001:db8:c59b::1 outboundASPrependCount: 3 inboundMED: 1000 outboundMED: 2000 customerAsn: 0 equinixAsn: 0 asOverrideEnabled: true bgpAuthKey: string bfd: enabled: true interval: 100 CreateRoutingWithDirectAndBGP: value: data: - type: BGP bgpIpv4: customerPeerIp: 192.168.100.2 equinixPeerIp: 192.168.100.1 outboundASPrependCount: 3 inboundMED: 1000 outboundMED: 2000 bgpIpv6: customerPeerIp: 2001:db8:c59b::2 equinixPeerIp: 2001:db8:c59b::1 outboundASPrependCount: 3 inboundMED: 1000 outboundMED: 2000 customerAsn: 0 equinixAsn: 0 bgpAuthKey: string asOverrideEnabled: true bfd: enabled: true interval: 100 - type: DIRECT name: My-Direct-route-1 directIpv4: equinixIfaceIp: 192.168.100.1/30 directIpv6: equinixIfaceIp: 2001:db8:c59b::1/125 400_routing_protocol: value: - errorCode: EQ-3041022 errorMessage: Invalid argument value passed correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec details: There are no available RFC3279 subnets on the same Fabric Cloud Router. - errorCode: EQ-3041023 errorMessage: Invalid pagination parameter. correlationId: test additionalInfo: - property: offset - reason: The offset parameter must be a Nonnegative Integer. - errorCode: EQ-3041012 errorMessage: The system is unable to process your request. details: The routing protocol associated with this Connection is in the transient state. correlationId: test additionalInfo: - reason: Routing protocol creation or deletion is not allowed if the routing protocol associated with connection is in the transient state. - errorCode: EQ-3041016 errorMessage: The system is unable to process your request. details: The BGP routing protocol should be deleted before deleting the DIRECT routing protocol for the same Connection. correlationId: test - errorCode: EQ-3041001 errorMessage: Invalid argument passed. correlationId: test - errorCode: EQ-3041002 errorMessage: Invalid argument value passed. correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec additionalInfo: - property: type reason: The type must be one of the following [DIRECT, BGP]. - errorCode: EQ-3041013 errorMessage: Required field. correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 additionalInfo: - property: $.type reason: Type is mandatory field. - errorCode: EQ-3041014 errorMessage: Json syntax error. Please check the request body. details: Json syntax error. Please check the request body. correlationId: test - errorCode: EQ-3041015 errorMessage: Invalid request. details: Value must not be null. correlationId: test additionalInfo: - property: data[0].directIpv6.equinixIfaceIp UpdateRoutingWithDirectOnly: value: type: DIRECT directIpv4: equinixIfaceIp: 192.168.100.1/30 directIpv6: equinixIfaceIp: 2001:7a9::34f4:0:f3dd:1/126 UpdateRoutingWithBGPOnly: value: type: BGP bgpIpv4: customerPeerIp: 192.168.100.2 equinixPeerIp: 192.168.100.1 outboundASPrependCount: 3 inboundMED: 1000 outboundMED: 2000 bgpIpv6: customerPeerIp: 2001:db8:c59b::2 equinixPeerIp: 2001:db8:c59b::1 outboundASPrependCount: 3 customerAsn: 0 equinixAsn: 0 bgpAuthKey: string asOverrideEnabled: true bfd: enabled: true interval: 100 RoutingProtocolReplaceBGPResponse: value: href: https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4 uuid: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 state: REPROVISIONING change: uuid: 3c9b8e7a2-f3b1-4576-a4a9-1366a63df170 href: https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4/changes/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170 type: ROUTING_PROTOCOL_UPDATE changelog: createdBy: abc@xyz.com createdByFullName: abc createdByEmail: abc@xyz.com createdDateTime: 2021-10-30T07:21:39Z updatedBy: abc@xyz.com updatedByFullName: abc updatedByEmail: abc@xyz.com updatedDateTime: 2021-10-30T07:21:39Z type: BGP bgpIpv4: customerPeerIp: 10.1.1.3 enabled: true outboundASPrependCount: 3 inboundMED: 1000 outboundMED: 2000 routesMax: 40 operation: operationalStatus: UNKNOWN customerAsn: 10000 equinixAsn: 10001 asOverrideEnabled: true RoutingProtocolReplaceDirectResponse: value: href: https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4 uuid: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 state: REPROVISIONING change: uuid: 3c9b8e7a2-f3b1-4576-a4a9-1366a63df170 href: https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4/changes/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170 type: ROUTING_PROTOCOL_UPDATE changelog: createdBy: abc@xyz.com createdByFullName: abc createdByEmail: abc@xyz.com createdDateTime: 2021-10-30T07:21:39Z updatedBy: abc@xyz.com updatedByFullName: abc updatedByEmail: abc@xyz.com updatedDateTime: 2021-10-30T07:21:39Z type: DIRECT directIpv4: equinixIfaceIp: 192.168.100.1/30 RoutingProtocolDeleteDirectResponse: value: href: https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4 uuid: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 state: DEPROVISIONING change: uuid: 3c9b8e7a2-f3b1-4576-a4a9-1366a63df170 href: https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4/changes/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170 type: ROUTING_PROTOCOL_DELETION changelog: createdBy: abc@xyz.com createdByFullName: abc createdByEmail: abc@xyz.com createdDateTime: 2021-10-30T07:21:39Z updatedBy: abc@xyz.com updatedByFullName: abc updatedByEmail: abc@xyz.com updatedDateTime: 2021-10-30T07:21:39Z deletedBy: abc@xyz.com deletedByFullName: abc deletedByEmail: abc@xyz.com deletedDateTime: 2021-10-30T07:21:39Z type: DIRECT directIpv4: equinixIfaceIp: 192.168.100.1/30 RoutingProtocolDeleteBGPResponse: value: href: https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4 uuid: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 state: DEPROVISIONING change: uuid: 3c9b8e7a2-f3b1-4576-a4a9-1366a63df170 href: https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4/changes/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170 type: ROUTING_PROTOCOL_DELETION changelog: createdBy: abc@xyz.com createdByFullName: abc createdByEmail: abc@xyz.com createdDateTime: 2021-10-30T07:21:39Z updatedBy: abc@xyz.com updatedByFullName: abc updatedByEmail: abc@xyz.com updatedDateTime: 2021-10-30T07:21:39Z type: BGP bgpIpv4: customerPeerIp: 10.1.1.3 enabled: true outboundASPrependCount: 3 inboundMED: 1000 outboundMED: 2000 routesMax: 40 operation: operationalStatus: UP opStatusChangedAt: 2021-10-30T07:21:39Z customerAsn: 10000 equinixAsn: 10001 asOverrideEnabled: true PatchRoutingProtocolEnableIPv4: value: - op: replace path: /bgpIpv4/enabled value: true PatchRoutingProtocolEnableIPv6: value: - op: replace path: /bgpIpv6/enabled value: true PatchRoutingProtocolDisableIPv4: value: - op: replace path: /bgpIpv4/enabled value: false PatchRoutingProtocolDisableIPv6: value: - op: replace path: /bgpIpv6/enabled value: false RoutingProtocolEnableBGPResponse: value: href: https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4 uuid: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 state: REPROVISIONING change: uuid: 3c9b8e7a2-f3b1-4576-a4a9-1366a63df170 href: https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4/changes/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170 type: ROUTING_PROTOCOL_UPDATE changelog: createdBy: abc@xyz.com createdByFullName: abc createdByEmail: abc@xyz.com createdDateTime: 2021-10-30T07:21:39Z updatedBy: abc@xyz.com updatedByFullName: abc updatedByEmail: abc@xyz.com updatedDateTime: 2021-10-30T07:21:39Z type: BGP bgpIpv4: enabled: true customerPeerIp: 10.1.1.3 outboundASPrependCount: 3 operation: operationalStatus: UNKNOWN customerAsn: 10000 equinixAsn: 10001 RoutingProtocolDisableBGPResponse: value: href: https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4 uuid: c9b8e7a2-f3b1-4576-a4a9-1366a63df170 state: REPROVISIONING change: uuid: 3c9b8e7a2-f3b1-4576-a4a9-1366a63df170 href: https://api.equinix.com/fabric/v4/connections/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170/routingProtocols/557400f8-d360-11e9-bb65-2a2ae2dbcce4/changes/3c9b8e7a2-f3b1-4576-a4a9-1366a63df170 type: ROUTING_PROTOCOL_UPDATE changelog: createdBy: abc@xyz.com createdByFullName: abc createdByEmail: abc@xyz.com createdDateTime: 2021-10-30T07:21:39Z updatedBy: abc@xyz.com updatedByFullName: abc updatedByEmail: abc@xyz.com updatedDateTime: 2021-10-30T07:21:39Z type: BGP bgpIpv4: enabled: false customerPeerIp: 10.1.1.3 outboundASPrependCount: 3 operation: operationalStatus: UNKNOWN customerAsn: 10000 equinixAsn: 10001 BGPActionsBulkDataResponseExample: value: pagination: offset: 0 limit: 20 total: 2 data: - href: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routingProtocols/3f5ed98a-8dba-4651-a317-8ad0234dd157/actions/835ed234-1dbb-5634-c320-25d0234dd117 uuid: 835ed234-1dbb-5634-c320-25d0234dd117 type: CLEAR_BGPIPV6_INBOUND description: soft clear bgp ipv6 inbound session state: SUCCEEDED 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:35:00Z - href: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routingProtocols/4d5ed98a-8dba-4651-a317-8ad0234dd157/actions/995ed98b-1db9-6653-c323-19d0234dd999 uuid: 995ed98b-1db9-6653-c323-19d0234dd999 type: CLEAR_BGPIPV4_INBOUND description: soft clear bgp ipv4 inbound session state: FAILED changeLog: createdBy: testuser createdByEmail: testuser@equinix.com createdByFullName: testuser testuser createdDateTime: 2020-05-21T10:20:00Z updatedBy: testuser updatedByEmail: testuser@equinix.com updatedByFullName: testuser testuser updatedDateTime: 2020-05-21T10:25:00Z BGPSoftClearInAndOutBoundIPv4: value: type: CLEAR_BGPIPV4 BGPSoftClearInAndOutBoundIPv6: value: type: CLEAR_BGPIPV6 BGPSoftClearInBoundIPv4: value: type: CLEAR_BGPIPV4_INBOUND BGPSoftClearInBoundIPv6: value: type: CLEAR_BGPIPV6_INBOUND BGPHardResetIPv4: value: type: RESET_BGPIPV4 BGPHardResetIPv6: value: type: RESET_BGPIPV6 BGPHardResetIPv4Response: value: href: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routingProtocols/3f5ed98a-8dba-4651-a317-8ad0234dd157/actions/123ed98a-92ba-9951-bb17-17d0234dd096 uuid: 123ed98a-92ba-9951-bb17-17d0234dd096 type: RESET_BGPIPV4 description: hard reset bgp ipv4 session state: PENDING changeLog: createdBy: adminuser createdByEmail: adminuser@equinix.com createdByFullName: adminuser adminuser createdDateTime: 2020-05-21T10:30:00Z BGPHardResetIPv6Response: value: href: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routingProtocols/3f5ed98a-8dba-4651-a317-8ad0234dd157/actions/123ed98a-92ba-9951-bb17-17d0234dd096 uuid: 123ed98a-92ba-9951-bb17-17d0234dd096 type: RESET_BGPIPV6 description: hard reset bgp ipv6 session state: PENDING changeLog: createdBy: adminuser createdByEmail: adminuser@equinix.com createdByFullName: adminuser adminuser createdDateTime: 2020-05-21T10:30:00Z BGPSoftClearInAndOutBoundIPv4Response: value: href: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routingProtocols/3f5ed98a-8dba-4651-a317-8ad0234dd157/actions/123ed98a-92ba-9951-bb17-17d0234dd096 uuid: 123ed98a-92ba-9951-bb17-17d0234dd096 type: CLEAR_BGPIPV4 description: soft clear bgp ipv4 inbound and outbound session state: PENDING changeLog: createdBy: adminuser createdByEmail: adminuser@equinix.com createdByFullName: adminuser adminuser createdDateTime: 2020-05-21T10:30:00Z BGPSoftClearInAndOutBoundIPv6Response: value: href: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routingProtocols/3f5ed98a-8dba-4651-a317-8ad0234dd157/actions/123ed98a-92ba-9951-bb17-17d0234dd096 uuid: 123ed98a-92ba-9951-bb17-17d0234dd096 type: CLEAR_BGPIPV6 description: soft clear bgp ipv6 inbound and outbound session state: PENDING changeLog: createdBy: adminuser createdByEmail: adminuser@equinix.com createdByFullName: adminuser adminuser createdDateTime: 2020-05-21T10:30:00Z BGPSoftClearInBoundIPv4Response: value: href: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routingProtocols/3f5ed98a-8dba-4651-a317-8ad0234dd157/actions/123ed98a-92ba-9951-bb17-17d0234dd096 uuid: 123ed98a-92ba-9951-bb17-17d0234dd096 type: CLEAR_BGPIPV4_INBOUND description: soft clear bgp ipv4 inbound session state: PENDING changeLog: createdBy: adminuser createdByEmail: adminuser@equinix.com createdByFullName: adminuser adminuser createdDateTime: 2020-05-21T10:30:00Z BGPSoftClearInBoundIPv6Response: value: href: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routingProtocols/3f5ed98a-8dba-4651-a317-8ad0234dd157/actions/123ed98a-92ba-9951-bb17-17d0234dd096 uuid: 123ed98a-92ba-9951-bb17-17d0234dd096 type: CLEAR_BGPIPV6_INBOUND description: soft clear bgp ipv6 inbound session state: PENDING changeLog: createdBy: adminuser createdByEmail: adminuser@equinix.com createdByFullName: adminuser adminuser createdDateTime: 2020-05-21T10:30:00Z BGPActionDataResponseExample: value: href: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routingProtocols/3f5ed98a-8dba-4651-a317-8ad0234dd157/actions/4e5ed00a-3dca-5652-b319-aad0234dd934 uuid: 4e5ed00a-3dca-5652-b319-aad0234dd934 type: CLEAR_BGPIPV6_INBOUND description: soft clear bgp ipv6 inbound session state: SUCCEEDED changeLog: createdBy: adminuser createdByEmail: adminuser@equinix.com createdByFullName: adminuser adminuser createdDateTime: 2020-05-21T10:30:00Z updatedBy: adminuser updatedByEmail: adminuser@equinix.com updatedByFullName: adminuser adminuser updatedDateTime: 2020-05-21T10:35:00Z RoutingProtocolGetChangeResponseExample: value: href: https://api.equinix.com/fabric/v4/connections/2a4fb415-5a7f-436f-bae6-02f5e403deec/routingProtocols/2a4fb415-5a7f-436f-bae6-02f5e403deec/changes/4b17da68-3d6b-436d-9c8f-2105f3b950d9 type: ROUTING_PROTOCOL_UPDATE uuid: 4b17da68-3d6b-436d-9c8f-2105f3b950d9 status: COMPLETED createdDateTime: 2020-05-21T10:30:00Z updatedDateTime: 2020-05-21T10:30:50Z data: op: replace path: / value: type: BGP name: My-BGP-route-1 bgpIpv4: customerPeerIp: 10.1.1.2 equinixPeerIp: 10.1.1.3 outboundASPrependCount: 3 inboundMED: 1000 outboundMED: 2000 routesMax: 40 operation: operationalStatus: UP opStatusChangedAt: 2021-10-30T07:21:39Z bgpIpv6: customerPeerIp: 2001:db8:c59b::1 equinixPeerIp: 2001:db8:c59b::1 outboundASPrependCount: 3 inboundMED: 1000 outboundMED: 2000 routesMax: 40 operation: operationalStatus: UP opStatusChangedAt: 2021-10-30T07:21:39Z customerAsn: 0 equinixAsn: 0 asOverrideEnabled: true bgpAuthKey: string bfd: enabled: true interval: "100" RoutingProtocolGetAllChangesResponseExample: value: pagination: offset: 0 limit: 20 total: 1 data: - href: https://api.equinix.com/fabric/v4/connections/2a4fb415-5a7f-436f-bae6-02f5e403deec/routingProtocols/2a4fb415-5a7f-436f-bae6-02f5e403deec/changes/4b17da68-3d6b-436d-9c8f-2105f3b950d9 type: ROUTING_PROTOCOL_UPDATE uuid: 4b17da68-3d6b-436d-9c8f-2105f3b950d9 status: COMPLETED createdDateTime: 2020-05-21T10:30:00Z updatedDateTime: 2020-05-21T10:30:50Z data: op: replace path: / value: type: BGP name: My-BGP-route-1 bgpIpv4: customerPeerIp: 10.1.1.2 equinixPeerIp: 10.1.1.3 outboundASPrependCount: 3 inboundMED: 1000 outboundMED: 2000 routesMax: 40 operation: operationalStatus: UP opStatusChangedAt: 2021-10-30T07:21:39Z bgpIpv6: customerPeerIp: 2001:db8:c59b::1 equinixPeerIp: 2001:db8:c59b::1 outboundASPrependCount: 3 inboundMED: 1000 outboundMED: 2000 routesMax: 40 operation: operationalStatus: UP opStatusChangedAt: 2021-10-30T07:21:39Z customerAsn: 0 equinixAsn: 0 bgpAuthKey: string asOverrideEnabled: true bfd: enabled: true interval: "100" - href: https://api.equinix.com/fabric/v4/connections/2a4fb415-5a7f-436f-bae6-02f5e403deec/routingProtocols/2a4fb415-5a7f-436f-bae6-02f5e403deec/changes/4b17da68-3d6b-436d-9c8f-2105f3b950d9 type: ROUTING_PROTOCOL_CREATION uuid: 4b17da68-3d6b-436d-9c8f-2105f3b950d9 status: COMPLETED createdDateTime: 2020-05-21T10:30:00Z updatedDateTime: 2020-05-21T10:30:50Z data: op: add path: / value: type: BGP name: My-BGP-route-1 bgpIpv4: customerPeerIp: 10.1.1.3 equinixPeerIp: 10.1.1.4 operation: operationalStatus: UP opStatusChangedAt: 2021-10-30T07:21:39Z bgpIpv6: customerPeerIp: 2001:db8:c59b::1 equinixPeerIp: 2001:db8:c59b::1 operation: operationalStatus: UP opStatusChangedAt: 2021-10-30T07:21:39Z customerAsn: 0 equinixAsn: 0 bgpAuthKey: string bfd: enabled: true interval: "100" ConnectionSearchDirection: value: filter: and: - property: /direction operator: = values: - OUTGOING pagination: limit: 25 offset: 0 total: 0 sort: - property: /changeLog/updatedDateTime direction: DESC ConnectionSearchIsremote: value: filter: and: - property: /isRemote operator: = values: - true pagination: limit: 25 offset: 0 total: 0 sort: - property: /changeLog/updatedDateTime direction: DESC ConnectionSearchName: value: filter: and: - property: /name operator: = values: - AWS-Dot1Q-AWSRemote pagination: limit: 25 offset: 0 sort: - property: /changeLog/updatedDateTime direction: DESC ConnectionSearchUuid: value: filter: and: - property: /uuid operator: = values: - 3736df8d-a903-42fd-bd06-06c9a76b238e pagination: limit: 25 offset: 0 total: 0 sort: - property: /changeLog/updatedDateTime direction: DESC ConnectionSearchCustorg: value: filter: and: - property: /account/orgId operator: = values: - 91997 pagination: limit: 25 offset: 0 total: 0 sort: - property: /changeLog/updatedDateTime direction: DESC ConnectionSearchAccountname: value: filter: and: - property: /aSide/accessPoint/account/accountName operator: = values: - testBuyer-270001 pagination: limit: 25 offset: 0 total: 0 sort: - property: /changeLog/updatedDateTime direction: DESC ConnectionSearchCloudRouteruuid: value: filter: and: - property: /aSide/accessPoint/router/uuid operator: = values: - 742e5b08-385a-4f50-94b8-08acdf91b7b0 pagination: limit: 25 offset: 0 sort: - property: /changeLog/updatedDateTime direction: DESC ConnectionSearchAsidevlanstagctag: value: filter: and: - property: /aSide/accessPoint/linkProtocol/vlanSTag operator: = values: - "4002" - property: /aSide/accessPoint/linkProtocol/vlanCTag operator: = values: - "0" sort: - direction: DESC property: /changeLog/updatedDateTime pagination: total: 0 limit: 25 offset: 0 ConnectionSearchAsidemetrocodemetroname: value: filter: and: - property: /aSide/accessPoint/location/metroCode operator: = values: - DA - property: /aSide/accessPoint/location/metroName operator: = values: - Dallas sort: - direction: DESC property: /changeLog/updatedDateTime pagination: total: 0 limit: 25 offset: 0 ConnectionSearchAsideaccesspointname: value: filter: and: - property: /aSide/accessPoint/port/name operator: = values: - l2-qa-1-DA1-L-Dot1q-STD-SEC-10G-NK-385 sort: - direction: DESC property: /changeLog/updatedDateTime pagination: total: 0 limit: 25 offset: 0 ConnectionSearchAsideaccesspointuuid: value: filter: and: - property: /aSide/accessPoint/port/uuid operator: = values: - c791f8cb-5941-9410-8ce0-306a5c00a4ee sort: - direction: DESC property: /changeLog/updatedDateTime pagination: total: 0 limit: 25 offset: 0 ConnectionSearchAsideaccesspointtype: value: filter: and: - property: /aSide/accessPoint/type operator: = values: - COLO sort: - direction: DESC property: /changeLog/updatedDateTime pagination: total: 0 limit: 25 offset: 0 ConnectionSearchAsidevirtualdevicename: value: filter: and: - property: /aSide/accessPoint/virtualDevice/name operator: = values: - E2E-NE-Device-Aut-170122034210108 sort: - direction: DESC property: /changeLog/updatedDateTime pagination: total: 0 limit: 25 offset: 0 ConnectionSearchAsidevirtualdeviceuuid: value: filter: and: - property: /aSide/accessPoint/virtualDevice/uuid operator: = values: - c6b96cec-cf70-4700-9c1e-2f73724d2fa5 sort: - direction: DESC property: /changeLog/updatedDateTime pagination: total: 0 limit: 25 offset: 0 ConnectionSearchAsideservicetokenuuid: value: filter: and: - property: /aSide/serviceToken/uuid operator: = values: - 30225621-c1ad-4614-b6a5-d9c70cad61cb sort: - direction: DESC property: /changeLog/updatedDateTime pagination: total: 0 limit: 25 offset: 0 ConnectionSearchChangestatus: value: filter: and: - property: /change/status operator: = values: - APPROVED pagination: limit: 25 offset: 0 total: 0 sort: - property: /changeLog/updatedDateTime direction: DESC ConnectionSearchUpdatedatetime: value: filter: and: - property: /changeLog/updatedDateTime operator: = values: - 2021-01-02T00:00:00Z sort: - direction: DESC property: /changeLog/updatedDateTime pagination: total: 0 limit: 25 offset: 0 ConnectionSearchEquinixstatus: value: filter: and: - property: /operation/equinixStatus operator: = values: - PROVISIONED sort: - direction: DESC property: /changeLog/updatedDateTime pagination: total: 0 limit: 25 offset: 0 ConnectionSearchProviderstatus: value: filter: and: - property: /operation/providerStatus operator: = values: - AVAILABLE sort: - direction: DESC property: /changeLog/updatedDateTime pagination: total: 0 limit: 25 offset: 0 ConnectionSearchProjectidOPtional-CRH: value: filter: and: - property: /project/projectId operator: = values: - 30ad25e2-53dc-11ed-bdc3-0242ac120002 pagination: limit: 25 offset: 0 total: 0 sort: - property: /changeLog/updatedDateTime direction: DESC ConnectionSearchRedundancygroup: value: filter: and: - operator: = property: /redundancy/group values: - 3f7ab592-0db3-41b8-bb9a-ecc05d5d5732 sort: - direction: DESC property: /changeLog/updatedDateTime pagination: total: 0 limit: 25 offset: 0 ConnectionSearchRedundancypriority: value: filter: and: - operator: = property: /redundancy/priority values: - PRIMARY sort: - direction: DESC property: /changeLog/updatedDateTime pagination: total: 0 limit: 25 offset: 0 ConnectionSearchZsidevlanstagctag: value: filter: and: - property: /zSide/accessPoint/linkProtocol/vlanSTag operator: = values: - "4002" - property: /zSide/accessPoint/linkProtocol/vlanCTag operator: = values: - "0" sort: - direction: DESC property: /changeLog/updatedDateTime pagination: total: 0 limit: 25 offset: 0 ConnectionSearchZsidemetrocodemetroname: value: filter: and: - property: /zSide/accessPoint/location/metroCode operator: = values: - DA - property: /zSide/accessPoint/location/metroName operator: = values: - Dallas sort: - direction: DESC property: /changeLog/updatedDateTime pagination: total: 0 limit: 25 offset: 0 ConnectionSearchZsideaccesspointname: value: filter: and: - property: /zSide/accessPoint/port/name operator: = values: - testGoogle-SV5-NL-Dot1q-STD-SEC-10G-JN-73 sort: - direction: DESC property: /changeLog/updatedDateTime pagination: total: 0 limit: 25 offset: 0 ConnectionSearchZsideaccesspointuuid: value: filter: and: - property: /zSide/accessPoint/port/uuid operator: = values: - c791f8cb-5941-9410-8ce0-306a5c00a4ee sort: - direction: DESC property: /changeLog/updatedDateTime pagination: total: 0 limit: 25 offset: 0 ConnectionSearchZsideaccesspointtype: value: filter: and: - property: /zSide/accessPoint/type operator: = values: - COLO sort: - direction: DESC property: /changeLog/updatedDateTime pagination: total: 0 limit: 25 offset: 0 ConnectionSearchZsidevirtualdevicename: value: filter: and: - property: /zSide/accessPoint/virtualDevice/name operator: = values: - E2E-NE-Device-Aut-170122034210108 sort: - direction: DESC property: /changeLog/updatedDateTime pagination: total: 0 limit: 25 offset: 0 ConnectionSearchZsidevirtualdeviceuuid: value: filter: and: - property: /zSide/accessPoint/virtualDevice/uuid operator: = values: - c6b96cec-cf70-4700-9c1e-2f73724d2fa5 sort: - direction: DESC property: /changeLog/updatedDateTime pagination: total: 0 limit: 25 offset: 0 ConnectionSearchZsideservicetokenuuid: value: filter: and: - property: /zSide/serviceToken/uuid operator: = values: - 019eab69-8293-4abf-ac8c-e6269d5a3e92 sort: - direction: DESC property: /changeLog/updatedDateTime pagination: total: 0 limit: 25 offset: 0 ConnectionSearchZsideprofileuuid: value: filter: and: - property: /zSide/accessPoint/profile/uuid operator: = values: - c6b96cec-cf70-4700-9c1e-2f73724d2fa5 sort: - direction: DESC property: /changeLog/updatedDateTime pagination: total: 0 limit: 25 offset: 0 ConnectionSearchANDwithNestedOR-LIKE: value: filter: and: - operator: = property: /operation/equinixStatus values: - PROVISIONED - PENDING_APPROVAL - operator: = property: /operation/providerStatus values: - AVAILABLE - PENDING_APPROVAL - PROVISIONED - or: - operator: LIKE property: /name values: - AWS-Dot1Q - operator: LIKE property: /aSide/accessPoint/account/accountName values: - AWS-Dot1Q - operator: LIKE property: /zSide/accessPoint/account/accountName values: - AWS-Dot1Q - operator: LIKE property: /uuid values: - AWS-Dot1Q - operator: LIKE property: /zSide/accessPoint/name values: - AWS-Dot1Q - operator: LIKE property: /aSide/accessPoint/linkProtocol/vlanCTag values: - AWS-Dot1Q - operator: LIKE property: /aSide/accessPoint/linkProtocol/vlanSTag values: - AWS-Dot1Q - operator: LIKE property: /zSide/accessPoint/linkProtocol/vlanCTag values: - AWS-Dot1Q - operator: LIKE property: /zSide/accessPoint/linkProtocol/vlanSTag values: - AWS-Dot1Q - operator: LIKE property: /aSide/accessPoint/linkProtocol/vlanCTag values: - AWS-Dot1Q - operator: LIKE property: /zSide/accessPoint/authenticationKey values: - AWS-Dot1Q - operator: LIKE property: /aSide/serviceToken/uuid values: - AWS-Dot1Q - operator: LIKE property: /zSide/serviceToken/uuid values: - AWS-Dot1Q sort: - direction: DESC property: /changeLog/updatedDateTime pagination: total: 0 limit: 25 offset: 0 ConnectionSearchORwithNestedAND: value: filter: or: - and: - operator: = property: /direction values: - INCOMING - operator: = property: /change/status values: - SUBMITTED_FOR_APPROVAL - and: - operator: = property: /direction values: - INCOMING - operator: = property: /operation/equinixStatus values: - PENDING_APPROVAL - PENDING_DELETE - and: - operator: = property: /direction values: - OUTGOING - operator: = property: /operation/providerStatus values: - PENDING_APPROVAL - operator: = property: /operation/equinixStatus values: - PROVISIONED pagination: limit: 1000 offset: 0 ConnectionSearchANDwithNestedIN: value: filter: and: - operator: = property: /type values: - EVPL_VC - operator: = property: /aSide/accessPoint/type values: - COLO - operator: = property: /aSide/accessPoint/location/metroCode values: - LD - operator: = property: /zSide/accessPoint/type values: - COLO - operator: = property: /zSide/accessPoint/location/metroCode values: - DA - operator: IN property: /bandwidth values: - "50" - "200" - "500" - "1000" - "2000" - "5000" - "10000" ConnectionSearchANDClause: value: filter: and: - property: /direction operator: = values: - OUTGOING - INTERNAL - property: /aSide/accessPoint/port/uuid operator: = values: - c791f8cb-5941-9410-8ce0-306a5c00a4ee - property: /operation/equinixStatus operator: = values: - PROVISIONED - property: /operation/providerStatus operator: = values: - PROVISIONED - AVAILABLE sort: - direction: DESC property: /changeLog/updatedDateTime pagination: limit: 25 offset: 0 ConnectionSearchANDwithNestedOR: value: filter: and: - operator: = property: /operation/equinixStatus values: - PROVISIONED - PENDING_APPROVAL - operator: = property: /operation/providerStatus values: - AVAILABLE - PENDING_APPROVAL - PROVISIONED - or: - operator: LIKE property: /name values: - AWS-Dot1Q - operator: LIKE property: /uuid values: - AWS-Dot1Q sort: - direction: DESC property: /changeLog/updatedDateTime pagination: limit: 25 offset: 0 VirtualConnectionProductEvplVcTypeFromColoToColo: value: filter: and: - property: /type operator: = values: - VIRTUAL_CONNECTION_PRODUCT - property: /connection/type operator: = values: - EVPL_VC - property: /connection/bandwidth operator: IN values: - "100" - property: /connection/aSide/accessPoint/type operator: = values: - COLO - property: /connection/aSide/accessPoint/location/metroCode operator: = values: - CH - property: /connection/aSide/accessPoint/port/settings/buyout operator: = values: - "false" - property: /connection/zSide/accessPoint/location/metroCode operator: = values: - CH - property: /connection/zSide/accessPoint/type operator: = values: - COLO VirtualConnectionProductEvplVcTypeFromColoToColoByPortUuid: value: filter: and: - property: /type operator: = values: - VIRTUAL_CONNECTION_PRODUCT - property: /connection/type operator: = values: - EVPL_VC - property: /connection/bandwidth operator: IN values: - "100" - property: /connection/aSide/accessPoint/type operator: = values: - COLO - property: /connection/aSide/accessPoint/port/uuid operator: = values: - b840a1db-54ab-4abf-97e0-328a5c00a874 - property: /connection/zSide/accessPoint/location/metroCode operator: = values: - CH - property: /connection/zSide/accessPoint/type operator: = values: - COLO VirtualConnectionProductEvplVcTypeFromColoToSP: value: filter: and: - property: /type operator: = values: - VIRTUAL_CONNECTION_PRODUCT - property: /connection/type operator: = values: - EVPL_VC - property: /connection/bandwidth operator: IN values: - "100" - property: /connection/aSide/accessPoint/type operator: = values: - COLO - property: /connection/aSide/accessPoint/location/metroCode operator: = values: - CH - property: /connection/aSide/accessPoint/port/settings/buyout operator: = values: - "false" - property: /connection/zSide/accessPoint/location/metroCode operator: = values: - CH - property: /connection/zSide/accessPoint/type operator: = values: - SP - property: /connection/zSide/accessPoint/profile/uuid operator: = values: - efeed227-765e-4f74-b14c-0c8a739be23e VirtualConnectionProductGwVcTypeFromGWToSP: value: filter: and: - property: /type operator: = values: - VIRTUAL_CONNECTION_PRODUCT - property: /connection/type operator: = values: - IP_VC - property: /connection/bandwidth operator: IN values: - "100" - property: /connection/aSide/accessPoint/type operator: = values: - CLOUD_ROUTER - property: /connection/aSide/accessPoint/location/metroCode operator: = values: - CH - property: /connection/zSide/accessPoint/location/metroCode operator: = values: - SV - property: /connection/zSide/accessPoint/type operator: = values: - SP - property: /connection/zSide/accessPoint/profile/uuid operator: = values: - efeed227-765e-4f74-b14c-0c8a739be23e VirtualConnectionProductGwVcTypeFromGWToColo: value: filter: and: - property: /type operator: = values: - VIRTUAL_CONNECTION_PRODUCT - property: /connection/type operator: = values: - IP_VC - property: /connection/bandwidth operator: IN values: - "100" - property: /connection/aSide/accessPoint/type operator: = values: - CLOUD_ROUTER - property: /connection/aSide/accessPoint/location/metroCode operator: = values: - CH - property: /connection/zSide/accessPoint/location/metroCode operator: = values: - CH - property: /connection/zSide/accessPoint/type operator: = values: - COLO VirtualConnectionProductGwVcTypeFromVDToColo: value: filter: and: - property: /type operator: = values: - VIRTUAL_CONNECTION_PRODUCT - property: /connection/type operator: = values: - IP_VC - property: /connection/bandwidth operator: IN values: - "100" - property: /connection/aSide/accessPoint/type operator: = values: - VD - property: /connection/aSide/accessPoint/location/metroCode operator: = values: - CH - property: /connection/zSide/accessPoint/location/metroCode operator: = values: - SV - property: /connection/zSide/accessPoint/type operator: = values: - SP - property: /connection/zSide/accessPoint/profile/uuid operator: = values: - efeed227-765e-4f74-b14c-0c8a739be23e VirtualConnectionProductEvplVcTypeFromVDToColo: value: filter: and: - property: /type operator: = values: - VIRTUAL_CONNECTION_PRODUCT - property: /connection/type operator: = values: - EVPL_VC - property: /connection/bandwidth operator: IN values: - "100" - property: /connection/aSide/accessPoint/type operator: = values: - VD - property: /connection/aSide/accessPoint/location/metroCode operator: = values: - CH - property: /connection/zSide/accessPoint/location/metroCode operator: = values: - SV - property: /connection/zSide/accessPoint/type operator: = values: - COLO VirtualConnectionProductVdChainTypeFromVDToChaingroup: value: filter: and: - property: /type operator: = values: - VIRTUAL_CONNECTION_PRODUCT - property: /connection/type operator: = values: - VD_CHAIN_VC - property: /connection/bandwidth operator: IN values: - "100" - property: /connection/aSide/accessPoint/type operator: = values: - VD - property: /connection/aSide/accessPoint/location/metroCode operator: = values: - CH - property: /connection/zSide/accessPoint/bridge/package/code operator: = values: - REGIONAL - property: /connection/zSide/accessPoint/type operator: = values: - CHAINGROUP VirtualConnectionProductOfflineEvplVcTypeFromColoToSp: value: filter: or: - and: - property: /type operator: = values: - VIRTUAL_CONNECTION_PRODUCT - property: /connection/type operator: = values: - EVPL_VC - property: /connection/bandwidth operator: IN values: - "100" - property: /connection/aSide/accessPoint/type operator: = values: - COLO - property: /connection/aSide/accessPoint/location/metroCode operator: = values: - CH - property: /connection/aSide/accessPoint/port/settings/buyout operator: = values: - "false" - property: /connection/zSide/accessPoint/location/metroCode operator: = values: - CH - property: /connection/zSide/accessPoint/type operator: = values: - SP - property: /connection/zSide/accessPoint/profile/uuid operator: = values: - efeed227-765e-4f74-b14c-0c8a739be23e - and: - property: /connection/uuid operator: = values: - efeed227-765e-4f74-b14c-0c8a739be23e VirtualConnectionProductEvpLanVcTypeFromColoToNetwork: value: filter: and: - property: /type operator: = values: - VIRTUAL_CONNECTION_PRODUCT - property: /connection/type operator: = values: - EVPLAN_VC - property: /connection/aSide/accessPoint/type operator: = values: - COLO - property: /connection/aSide/accessPoint/location/metroCode operator: = values: - DA - property: /connection/aSide/accessPoint/port/settings/buyout operator: = values: - "true" - property: /connection/zSide/accessPoint/type operator: = values: - NETWORK - property: /connection/zSide/accessPoint/network/scope operator: = values: - REGIONAL - property: /connection/bandwidth operator: IN values: - "10" FabricCloudRouterProduct: value: filter: and: - property: /type operator: = values: - CLOUD_ROUTER_PRODUCT - property: /router/location/metroCode operator: = values: - CH - property: /router/package/code operator: IN values: - LAB - ADVANCED - STANDARD - PREMIUM IpBlockProduct: value: filter: and: - property: /type operator: = values: - IP_BLOCK_PRODUCT - property: /ipBlock/type operator: = values: - IPv4 - property: /ipBlock/prefixLength operator: = values: - "29" - property: /ipBlock/location/metroCode operator: IN values: - SV - WA VirtualPortProduct: value: filter: and: - property: /type operator: = values: - VIRTUAL_PORT_PRODUCT - property: /account/accountNumber operator: = values: - "270001" - property: /port/location/ibx operator: = values: - DA1 - property: /port/type operator: = values: - XF_PORT - property: /port/bandwidth operator: = values: - "1000" - property: /port/settings/buyout operator: = values: - "false" - property: /port/serviceType operator: = values: - EPL - property: /port/connectivitySource/type operator: = values: - COLO - property: /port/lag/enabled operator: = values: - "false" PrecisionTimeNtpStandardPackage: value: filter: and: - property: /type operator: = values: - PRECISION_TIME_PRODUCT - property: /account/accountNumber operator: = values: - "270001" - property: /timeService/type operator: = values: - NTP - property: /timeService/package/code operator: = values: - NTP_STANDARD - property: /connection/aSide/accessPoint/location/ibx operator: = values: - CH3 PrecisionTimeNtpEnterprisePackage: value: filter: and: - property: /type operator: = values: - PRECISION_TIME_PRODUCT - property: /account/accountNumber operator: = values: - "270001" - property: /timeService/type operator: = values: - NTP - property: /timeService/package/code operator: = values: - NTP_ENTERPRISE - property: /connection/aSide/accessPoint/location/metroCode operator: = values: - CH PrecisionTimePtpStandardPackage: value: filter: and: - property: /type operator: = values: - PRECISION_TIME_PRODUCT - property: /account/accountNumber operator: = values: - "270001" - property: /timeService/type operator: = values: - PTP - property: /timeService/package/code operator: = values: - PTP_STANDARD - property: /connection/aSide/accessPoint/location/ibx operator: = values: - CH3 PrecisionTimePtpEnterprisePackage: value: filter: and: - property: /type operator: = values: - PRECISION_TIME_PRODUCT - property: /account/accountNumber operator: = values: - "270001" - property: /timeService/type operator: = values: - PTP - property: /timeService/package/code operator: = values: - PTP_ENTERPRISE - property: /connection/aSide/accessPoint/location/ibx operator: = values: - CH3 VirtualConnection: value: pagination: offset: 0 limit: 1 total: 1 data: - type: VIRTUAL_CONNECTION_PRODUCT code: ECX00015.PROD name: Equinix Fabric Virtual Connection Product description: Equinix Fabric Virtual Connection account: accountNumber: 200001 charges: - type: MONTHLY_RECURRING price: 500 currency: USD connection: type: EVPL_VC bandwidth: 100 aSide: accessPoint: type: COLO location: metroCode: CH port: settings: buyout: false zSide: accessPoint: type: SP location: metroCode: CH profile: uuid: 20d32a80-0d61-4333-bc03-707b591ae2f2 IpBlock: value: pagination: offset: 0 limit: 1 total: 1 data: - type: IP_BLOCK_PRODUCT code: ECX00005.PROD name: Equinix Fabric IP Addressing Product description: Equinix Fabric IP Addressing charges: - type: MONTHLY_RECURRING price: 20 currency: USD ipBlock: type: IPv4 prefixLength: 29 location: metroCode: CH FabricCloudRouter: value: pagination: offset: 0 limit: 1 total: 1 data: - type: CLOUD_ROUTER_PRODUCT code: ECX00014.PROD name: Equinix Cloud Router Product description: Equinix Cloud Router account: accountNumber: 200001 charges: - type: MONTHLY_RECURRING price: 5000 currency: USD router: package: code: ADVANCED location: metroCode: CH VirtualPort: value: pagination: offset: 0 limit: 1 total: 1 data: - type: VIRTUAL_PORT_PRODUCT code: ECX00001.PROD name: Equinix Fabric Port Product description: Equinix Fabric Port account: accountNumber: 200001 charges: - type: MONTHLY_RECURRING price: 500 - type: NON_RECURRING price: 100 currency: USD port: type: XF_PORT location: ibx: DA1 lag: enabled: false physicalPortsQuantity: 1 bandwidth: 1000 connectivitySource: type: COLO serviceType: EPL settings: buyout: false PrecisionTimeService: value: pagination: offset: 0 limit: 1 total: 1 data: - type: PRECISION_TIME_PRODUCT code: EDG00009.PROD name: Equinix Precision Time Product description: Equinix Precision Time Product account: accountNumber: 270001 charges: - type: MONTHLY_RECURRING price: 495 currency: USD timeService: type: NTP package: code: NTP_STANDARD connection: aSide: accessPoint: location: metroCode: CH ibx: CH3 400_prices: value: - errorCode: EQ-3038010 errorMessage: Validation failure details: Invalid request body additionalInfo: - property: /connection/zSide/accessPoint/location/metroCode reason: /connection/zSide/accessPoint/location/metroCode has invalid format 500_prices: value: - errorCode: EQ-3038030 errorMessage: Internal Server Error details: We couldn't process you request 200_port: value: href: https://api.equinix.com/fabric/v4/ports/xxxxx191-xx70-xxxx-xx04-xxxxxxxa37xx type: XF_PORT uuid: xxxxx191-xx70-xxxx-xx04-xxxxxxxa37xx name: Equinix-EM-CX-xxx-L-Dot1q-BO-100G-PRI-xx bandwidthUtilization: 10000 stats: startDateTime: 2020-05-21T08:00:00Z endDateTime: 2020-05-21T10:30:00Z bandwidthUtilization: unit: Mbps metricInterval: PT5M inbound: max: 68.00905623111112 mean: 48.90562310112 lastPolled: 41.00905623111112 metrics: - intervalEndDateTime: 2020-05-21T10:30:00Z max: 45.5623145112009 mean: 31.38641687333333 outbound: max: 41.99068261111111 mean: 33.70374303096296 lastPolled: 41.43428905111111 metrics: - intervalEndDateTime: 2020-05-21T10:30:00Z max: 42.01401189333334 mean: 39.40894303096296 200_vc: value: href: https://api.equinix.com/fabric/v4/connections/97d1850f-4df0-468c-9281-fa7b0dfa2096 type: EVPL_VC uuid: 97d1850f-4df0-468c-9281-fa7b0dfa2096 name: Admin-STATS-123-Abc stats: startDateTime: 2021-01-10T20:05:08Z endDateTime: 2021-01-10T21:05:08Z viewPoint: aSide bandwidthUtilization: unit: Mbps metricInterval: PT5M inbound: max: 68.38641687333333 mean: 39.96267986650665 lastPolled: 41.00905623111112 metrics: - intervalEndDateTime: 2021-01-10T20:05:00Z max: 41.89234537555556 mean: 33.62481298948148 - intervalEndDateTime: 2021-01-10T20:10:00Z max: 41.86234987534256 mean: 36.92451598748148 - intervalEndDateTime: 2021-01-10T20:15:00Z max: 41.86907222888888 mean: 43.98230834555556 - intervalEndDateTime: 2021-01-10T20:20:00Z max: 41.91562025333334 mean: 41.086565260765425 outbound: max: 67.79944363333334 mean: 38.116581250214345 lastPolled: 41.43428905111111 metrics: - intervalEndDateTime: 2021-01-10T20:05:00Z max: 41.99068261111111 mean: 33.70374303096296 - intervalEndDateTime: 2021-01-10T20:10:00Z max: 42.56065261666111 mean: 31.52464373892222 - intervalEndDateTime: 2021-01-10T20:15:00Z max: 41.96735416222222 mean: 44.08555118977779 - intervalEndDateTime: 2021-01-10T20:20:00Z max: 42.01401189333334 mean: 39.40894303096296 ServiceProfilesResponse: value: data: - state: ACTIVE account: organizationName: testSeller-270010 changeLog: createdBy: fusiontestseller createdByFullName: fusiontestSeller fusiontestSeller createdByEmail: fusiontestSeller@equinix.com createdDateTime: 2022-04-12T19:06:57.940Z updatedBy: fusiontestseller updatedByFullName: fusiontestSeller fusiontestSeller updatedByEmail: fusiontestSeller@equinix.com updatedDateTime: 2022-04-12T19:11:04.017Z href: https://api.equinix.com/fabric/v4/serviceProfiles/ea4b5141-e4d2-49f1-9768-4ea6e215b37f?viewPoint=aSide type: L2_PROFILE name: Service Profile 2 uuid: ea4b5141-e4d2-49f1-9768-4ea6e215b37f description: Sample_description visibility: PUBLIC allowedEmails: - test@equinix.com - testagain@equinix.com accessPointTypeConfigs: - type: COLO uuid: f20c49cd-b022-4aeb-b3e4-49db4389aff3 supportedBandwidths: - 100 - 500 allowRemoteConnections: false allowCustomBandwidth: true allowBandwidthAutoApproval: false linkProtocolConfig: encapsulationStrategy: CTAGED reuseVlanSTag: false encapsulation: DOT1Q enableAutoGenerateServiceKey: false connectionRedundancyRequired: false apiConfig: apiAvailable: false bandwidthFromApi: false connectionLabel: true1 authenticationKey: required: false label: Service Key marketingInfo: promotion: true metros: - code: SY name: Sydney ibxs: - SY4 displayName: Sydney selfProfile: true pagination: offset: 0 limit: 1 total: 52 next: /serviceProfiles?offset=1&limit=1 SellerServiceProfilesResponse: value: data: - state: ACTIVE account: orgId: 91785 organizationName: testSeller-270010 globalOrgId: 0016u000003JZ4tAAG changeLog: createdBy: fusiontestseller createdByFullName: fusiontestSeller fusiontestSeller createdByEmail: fusiontestSeller@equinix.com createdDateTime: 2022-04-12T19:06:57.940Z updatedBy: fusiontestseller updatedByFullName: fusiontestSeller fusiontestSeller updatedByEmail: fusiontestSeller@equinix.com updatedDateTime: 2022-04-12T19:11:04.017Z href: https://api.equinix.com/fabric/v4/serviceProfiles/ea4b5141-e4d2-49f1-9768-4ea6e215b37f?viewPoint=zSide type: L2_PROFILE name: Service Profile 2 uuid: ea4b5141-e4d2-49f1-9768-4ea6e215b37f description: Sample_description notifications: - type: BANDWIDTH_ALERT emails: - someone@sample.com - type: CONNECTION_APPROVAL emails: - someone@sample.com - type: PROFILE_LIFECYCLE emails: - someone@sample.com visibility: PUBLIC allowedEmails: - test@equinix.com - testagain@equinix.com accessPointTypeConfigs: - type: COLO uuid: f20c49cd-b022-4aeb-b3e4-49db4389aff3 supportedBandwidths: - 100 - 500 allowRemoteConnections: false allowCustomBandwidth: true bandwidthAlertThreshold: 10 allowBandwidthAutoApproval: false linkProtocolConfig: encapsulationStrategy: CTAGED reuseVlanSTag: false encapsulation: DOT1Q enableAutoGenerateServiceKey: false connectionRedundancyRequired: false apiConfig: apiAvailable: false equinixManagedPort: true equinixManagedVlan: true allowOverSubscription: false overSubscriptionLimit: 1 bandwidthFromApi: false connectionLabel: true1 authenticationKey: required: false label: Service Key marketingInfo: promotion: true ports: - type: XF_PORT uuid: c791f8cb-5cc9-cc90-8ce0-306a5c00a4ee location: metroCode: SY metros: - code: SY name: Sydney ibxs: - SY4 displayName: Sydney pagination: offset: 0 limit: 1 total: 31898 next: /serviceProfiles?offset=1&limit=1 sp-400: value: - errorCode: EQ-3001015 errorMessage: Access point is not accessible - errorCode: EQ-3001014 errorMessage: Redundant Service Profile requires at least one primary port and one secondary port in a metro - errorCode: EQ-3001013 errorMessage: Some of the access point are duplicate - errorCode: EQ-3001012 errorMessage: access point with same port encapsulation will be allowed in service profile request - errorCode: EQ-3001019 errorMessage: If apiAvailable, then integrationId is mandatory - errorCode: EQ-3001020 errorMessage: Speed from api required - errorCode: EQ-3001021 errorMessage: Speedbands not allowed - errorCode: EQ-3001112 errorMessage: API Integration should be enabled with Integration ID for deriving speed from API - errorCode: EQ-3001023 errorMessage: Speed band length is invalid - errorCode: EQ-3001024 errorMessage: Invalid api available - errorCode: EQ-3001025 errorMessage: Seller port encapsulation cannot be DOT1Q if Auto generate service key is True - errorCode: EQ-3001026 errorMessage: "customFields[].options : must have values for customField with dataType=LIST" - errorCode: EQ-3001027 errorMessage: Duplicate custom field lables - errorCode: EQ-3001113 errorMessage: Service profile can be updated to ACTIVE or REJECTED - errorCode: EQ-3001114 errorMessage: Some of the profile with the given id either not in valid state or not exist in database - errorCode: EQ-3001115 errorMessage: Unable to delete some of the profile because it does not exist - errorCode: EQ-3001116 errorMessage: get metros call failed - errorCode: EQ-3001028 errorMessage: Cannot change service profile type - errorCode: EQ-3001029 errorMessage: Cannot change state if not admin user - errorCode: EQ-3001030 errorMessage: Invalid Custom Field dataType - errorCode: EQ-3001031 errorMessage: Invalid notification.type value - errorCode: EQ-3001032 errorMessage: "serviceProfile.type : unsupported value" - errorCode: EQ-3001022 errorMessage: Only alphanumeric, hyphen(-) and underscore(_) characters are allowed in service profile name. Other special characters are not allowed - errorCode: EQ-3001204 errorMessage: EPL ports are not supported sp-401: value: - errorCode: EQ-3001207 errorMessage: Unauthorized user sp-403-read: value: - errorCode: EQ-3001033 errorMessage: You are not authorized to execute the requested action on the resource sp-500: value: - errorCode: EQ-3001206 errorMessage: Internal Server Error ServiceProfileCreate: value: name: Service Profile 1 description: Sample_description type: L2_PROFILE notifications: - emails: - someone@sample.com type: BANDWIDTH_ALERT visibility: PUBLIC allowedEmails: - test@equinix.com - testagain@equinix.com ports: - uuid: c791f8cb-5cc9-cc90-8ce0-306a5c00a4ee type: XF_PORT location: metroCode: SY marketingInfo: promotion: true accessPointTypeConfigs: - type: COLO connectionRedundancyRequired: false allowBandwidthAutoApproval: false allowRemoteConnections: true connectionLabel: Service Profile 1 enableAutoGenerateServiceKey: false bandwidthAlertThreshold: 10 allowCustomBandwidth: true apiConfig: apiAvailable: false equinixManagedVlan: false bandwidthFromApi: false integrationId: null equinixManagedPort: false authenticationKey: required: false label: Service Key description: XYZ supportedBandwidths: - 100 - 500 ServiceProfileCreate-CRH: value: name: Service Profile 1 description: Sample_description type: L2_PROFILE notifications: - emails: - someone@sample.com type: BANDWIDTH_ALERT project: projectId: 30ad25e2-53dc-11ed-bdc3-0242ac120002 visibility: PUBLIC allowedEmails: - test@equinix.com - testagain@equinix.com ports: - uuid: c791f8cb-5cc9-cc90-8ce0-306a5c00a4ee type: XF_PORT location: metroCode: SY marketingInfo: promotion: true accessPointTypeConfigs: - type: COLO connectionRedundancyRequired: false allowBandwidthAutoApproval: false allowRemoteConnections: true connectionLabel: Service Profile 1 enableAutoGenerateServiceKey: false bandwidthAlertThreshold: 10 allowCustomBandwidth: true apiConfig: apiAvailable: false equinixManagedVlan: false bandwidthFromApi: false integrationId: null equinixManagedPort: false authenticationKey: required: false label: Service Key description: XYZ supportedBandwidths: - 100 - 500 ServiceProfileCreateResponse: value: state: PENDING_APPROVAL account: orgId: 91785 globalOrgId: 0016u000003JZ4tAAG changeLog: createdDateTime: 2022-04-12T19:06:57.940Z href: https://api.equinix.com/fabric/v4/serviceProfiles/ea4b5141-e4d2-49f1-9768-4ea6e215b37f type: L2_PROFILE name: Service Profile 1 uuid: ea4b5141-e4d2-49f1-9768-4ea6e215b37f description: Sample_description notifications: - type: BANDWIDTH_ALERT emails: - someone@sample.com - type: CONNECTION_APPROVAL emails: - someone@sample.com - type: PROFILE_LIFECYCLE emails: - someone@sample.com visibility: PUBLIC allowedEmails: - test@equinix.com - testagain@equinix.com accessPointTypeConfigs: - type: COLO uuid: f20c49cd-b022-4aeb-b3e4-49db4389aff3 supportedBandwidths: - 100 - 500 allowRemoteConnections: false allowCustomBandwidth: true bandwidthAlertThreshold: 10 allowBandwidthAutoApproval: false linkProtocolConfig: encapsulationStrategy: CTAGED reuseVlanSTag: false encapsulation: DOT1Q enableAutoGenerateServiceKey: false connectionRedundancyRequired: false apiConfig: apiAvailable: false equinixManagedPort: true equinixManagedVlan: true allowOverSubscription: false overSubscriptionLimit: 1 bandwidthFromApi: false connectionLabel: true1 authenticationKey: required: false label: Service Key marketingInfo: promotion: true ports: - type: XF_PORT uuid: c791f8cb-5cc9-cc90-8ce0-306a5c00a4ee location: metroCode: SY metros: - code: SY ibxs: - SY4 sp-403-create: value: - errorCode: EQ-3001036 errorMessage: You are not authorized to execute the requested action on the resource ServiceProfileSearchWithUuid: value: filter: property: /uuid operator: = values: - 13100b2d-234f-4425-ab5c-1449d4b806be pagination: offset: 0 limit: 20 sort: - direction: DESC property: /changeLog/updatedDateTime ServiceProfileSearchWithName: value: filter: property: /name operator: = values: - My-Service-Profile-1 pagination: offset: 0 limit: 20 sort: - direction: DESC property: /changeLog/updatedDateTime ServiceProfileSearchWithState: value: filter: property: /state operator: = values: - ACTIVE pagination: offset: 0 limit: 20 sort: - direction: DESC property: /changeLog/updatedDateTime ServiceProfileSearchWithVisibility: value: filter: property: /visibility operator: = values: - PUBLIC pagination: offset: 0 limit: 20 sort: - direction: DESC property: /changeLog/updatedDateTime ServiceProfileSearchWithProjectId: value: filter: property: /project/projectId operator: = values: - e365ab86-0103-44a6-a08b-120c4374b000 pagination: offset: 0 limit: 20 sort: - direction: DESC property: /changeLog/updatedDateTime ServiceProfileSearchWithPort: value: filter: property: /ports/uuid operator: = values: - 23100b2d-234f-4425-ab5c-1449d4b806bf pagination: offset: 0 limit: 20 sort: - direction: DESC property: /changeLog/updatedDateTime ServiceProfileSearchWithAnd: value: filter: and: - property: /state operator: = values: - ACTIVE - property: /visibility operator: = values: - PRIVATE pagination: offset: 0 limit: 20 sort: - direction: DESC property: /changeLog/updatedDateTime sp-400-search: value: - errorCode: EQ-3001022 errorMessage: INVALID_VALUE - errorCode: EQ-3001202 errorMessage: Unsupported search property details: "Supported search properties are : /name,/uuid,/state,/metros/code,/visibility,/type" - errorCode: EQ-3001202 errorMessage: Unsupported search property details: "Supported search operator is : =" - errorCode: EQ-3001022 errorMessage: "pagination.limit : must be greater than or equal to 1" additionalInfo: - property: pagination.limit reason: must be greater than or equal to 1 - errorCode: EQ-3001022 errorMessage: "pagination.offset : must be greater than or equal to 0" additionalInfo: - property: pagination.offset reason: must be greater than or equal to 0 - errorCode: EQ-3001022 errorMessage: Unexpected value ServiceProfileResponse: value: state: ACTIVE account: organizationName: testSeller-270010 changeLog: createdBy: fusiontestseller createdByFullName: fusiontestSeller fusiontestSeller createdByEmail: fusiontestSeller@equinix.com createdDateTime: 2022-04-12T19:06:57.940Z updatedBy: fusiontestseller updatedByFullName: fusiontestSeller fusiontestSeller updatedByEmail: fusiontestSeller@equinix.com updatedDateTime: 2022-04-12T19:11:04.017Z href: https://api.equinix.com/fabric/v4/serviceProfiles/ea4b5141-e4d2-49f1-9768-4ea6e215b37f?viewPoint=aSide type: L2_PROFILE name: Service Profile 2 uuid: ea4b5141-e4d2-49f1-9768-4ea6e215b37f description: Sample_description visibility: PUBLIC allowedEmails: - test@equinix.com - testagain@equinix.com accessPointTypeConfigs: - type: COLO uuid: f20c49cd-b022-4aeb-b3e4-49db4389aff3 supportedBandwidths: - 100 - 500 allowRemoteConnections: false allowCustomBandwidth: true allowBandwidthAutoApproval: false linkProtocolConfig: encapsulationStrategy: CTAGED reuseVlanSTag: false encapsulation: DOT1Q enableAutoGenerateServiceKey: false connectionRedundancyRequired: false apiConfig: apiAvailable: false bandwidthFromApi: false connectionLabel: true1 authenticationKey: required: false label: Service Key marketingInfo: promotion: true metros: - code: SY name: Sydney ibxs: - SY4 displayName: Sydney selfProfile: true SellerServiceProfileResponse: value: state: ACTIVE account: orgId: 91785 organizationName: testSeller-270010 globalOrgId: 0016u000003JZ4tAAG changeLog: createdBy: fusiontestseller createdByFullName: fusiontestSeller fusiontestSeller createdByEmail: fusiontestSeller@equinix.com createdDateTime: 2022-04-12T19:06:57.940Z updatedBy: fusiontestseller updatedByFullName: fusiontestSeller fusiontestSeller updatedByEmail: fusiontestSeller@equinix.com updatedDateTime: 2022-04-12T19:11:04.017Z href: https://api.equinix.com/fabric/v4/serviceProfiles/ea4b5141-e4d2-49f1-9768-4ea6e215b37f?viewPoint=zSide type: L2_PROFILE name: Service Profile 2 uuid: ea4b5141-e4d2-49f1-9768-4ea6e215b37f description: Sample_description notifications: - type: BANDWIDTH_ALERT emails: - someone@sample.com - type: CONNECTION_APPROVAL emails: - someone@sample.com - type: PROFILE_LIFECYCLE emails: - someone@sample.com visibility: PUBLIC allowedEmails: - test@equinix.com - testagain@equinix.com accessPointTypeConfigs: - type: COLO uuid: f20c49cd-b022-4aeb-b3e4-49db4389aff3 supportedBandwidths: - 100 - 500 allowRemoteConnections: false allowCustomBandwidth: true bandwidthAlertThreshold: 10 allowBandwidthAutoApproval: false linkProtocolConfig: encapsulationStrategy: CTAGED reuseVlanSTag: false encapsulation: DOT1Q enableAutoGenerateServiceKey: false connectionRedundancyRequired: false apiConfig: apiAvailable: false equinixManagedPort: true equinixManagedVlan: true allowOverSubscription: false overSubscriptionLimit: 1 bandwidthFromApi: false connectionLabel: true1 authenticationKey: required: false label: Service Key marketingInfo: promotion: true ports: - type: XF_PORT uuid: c791f8cb-5cc9-cc90-8ce0-306a5c00a4ee location: metroCode: SY metros: - code: SY name: Sydney ibxs: - SY4 displayName: Sydney ServiceProfileUpdate: value: name: Service Profile 2 description: Sample_description type: L2_PROFILE notifications: - emails: - someone@sample.com type: BANDWIDTH_ALERT visibility: PUBLIC allowedEmails: - test@equinix.com - testagain@equinix.com ports: - uuid: c791f8cb-5cc9-cc90-8ce0-306a5c00a4ee type: XF_PORT location: metroCode: SY marketingInfo: promotion: true accessPointTypeConfigs: - type: COLO connectionRedundancyRequired: false allowBandwidthAutoApproval: false allowRemoteConnections: false connectionLabel: true1 enableAutoGenerateServiceKey: false bandwidthAlertThreshold: 10 allowCustomBandwidth: true apiConfig: apiAvailable: false equinixManagedVlan: true bandwidthFromApi: false integrationId: null equinixManagedPort: true authenticationKey: required: false label: Service Key description: XYZ supportedBandwidths: - 100 - 500 ServiceProfilePutResponse: value: state: ACTIVE account: orgId: 91785 organizationName: testSeller-270010 globalOrgId: 0016u000003JZ4tAAG changeLog: createdBy: fusiontestseller createdByFullName: fusiontestSeller fusiontestSeller createdByEmail: fusiontestSeller@equinix.com createdDateTime: 2022-04-12T19:06:57.940Z updatedDateTime: 2022-04-12T19:11:04.017Z href: https://api.equinix.com/fabric/v4/serviceProfiles/ea4b5141-e4d2-49f1-9768-4ea6e215b37f type: L2_PROFILE name: Service Profile 2 uuid: ea4b5141-e4d2-49f1-9768-4ea6e215b37f description: Sample_description notifications: - type: BANDWIDTH_ALERT emails: - someone@sample.com - type: CONNECTION_APPROVAL emails: - someone@sample.com - type: PROFILE_LIFECYCLE emails: - someone@sample.com visibility: PUBLIC allowedEmails: - test@equinix.com - testagain@equinix.com accessPointTypeConfigs: - type: COLO uuid: f20c49cd-b022-4aeb-b3e4-49db4389aff3 supportedBandwidths: - 100 - 500 allowRemoteConnections: false allowCustomBandwidth: true bandwidthAlertThreshold: 10 allowBandwidthAutoApproval: false linkProtocolConfig: encapsulationStrategy: CTAGED reuseVlanSTag: false encapsulation: DOT1Q enableAutoGenerateServiceKey: false connectionRedundancyRequired: false apiConfig: apiAvailable: false equinixManagedPort: true equinixManagedVlan: true allowOverSubscription: false overSubscriptionLimit: 1 bandwidthFromApi: false connectionLabel: true1 authenticationKey: required: false label: Service Key marketingInfo: promotion: true ports: - type: XF_PORT uuid: c791f8cb-5cc9-cc90-8ce0-306a5c00a4ee location: metroCode: SY metros: - code: SY name: Sydney ibxs: - SY4 displayName: Sydney sp-403-update: value: - errorCode: EQ-3001035 errorMessage: You are not authorized to execute the requested action on the resource sp-404-get: value: - errorCode: EQ-3001011 errorMessage: Invalid uuid ServiceProfileDeleteResponse: value: state: DELETED account: orgId: 91785 organizationName: testSeller-270010 globalOrgId: 0016u000003JZ4tAAG changeLog: createdBy: fusiontestseller createdByFullName: fusiontestSeller fusiontestSeller createdByEmail: fusiontestSeller@equinix.com createdDateTime: 2022-04-12T19:06:57.940Z updatedBy: fusiontestseller updatedByFullName: fusiontestSeller fusiontestSeller updatedByEmail: fusiontestSeller@equinix.com updatedDateTime: 2022-04-12T21:53:57.816Z href: https://api.equinix.com/fabric/v4/serviceProfiles/ea4b5141-e4d2-49f1-9768-4ea6e215b37f type: L2_PROFILE name: Service Profile 2 uuid: ea4b5141-e4d2-49f1-9768-4ea6e215b37f description: Sample_description notifications: - type: BANDWIDTH_ALERT emails: - someone@sample.com - type: CONNECTION_APPROVAL emails: - someone@sample.com - type: PROFILE_LIFECYCLE emails: - someone@sample.com tags: - sample_tag visibility: PUBLIC allowedEmails: - test@equinix.com - testagain@equinix.com accessPointTypeConfigs: - type: COLO uuid: f20c49cd-b022-4aeb-b3e4-49db4389aff3 supportedBandwidths: - 100 - 500 allowRemoteConnections: false allowCustomBandwidth: true bandwidthAlertThreshold: 10 allowBandwidthAutoApproval: false linkProtocolConfig: encapsulationStrategy: CTAGED reuseVlanSTag: false encapsulation: DOT1Q enableAutoGenerateServiceKey: false connectionRedundancyRequired: false apiConfig: apiAvailable: false equinixManagedPort: true equinixManagedVlan: true allowOverSubscription: false overSubscriptionLimit: 1 bandwidthFromApi: false connectionLabel: true1 authenticationKey: required: false label: Service Key marketingInfo: promotion: true ports: - type: XF_PORT uuid: c791f8cb-5cc9-cc90-8ce0-306a5c00a4ee location: metroCode: SY metros: - code: SY name: Sydney ibxs: - SY4 displayName: Sydney sp-400-delete: value: - errorCode: EQ-3001115 errorMessage: Unable to delete some of the profile because it does not exist sp-403-delete: value: - errorCode: EQ-3001034 errorMessage: You are not authorized to execute the requested action on the resource ServiceProfilePatchRequest: value: - op: add path: /tags value: - sample_tag ServiceProfilePatchResponse: value: state: ACTIVE account: orgId: 91785 organizationName: testSeller-270010 globalOrgId: 0016u000003JZ4tAAG changeLog: createdBy: fusiontestseller createdByFullName: fusiontestSeller fusiontestSeller createdByEmail: fusiontestSeller@equinix.com createdDateTime: 2022-04-12T19:06:57.940Z updatedDateTime: 2022-04-12T19:11:04.017Z href: https://api.equinix.com/fabric/v4/serviceProfiles/ea4b5141-e4d2-49f1-9768-4ea6e215b37f type: L2_PROFILE name: Service Profile 2 uuid: ea4b5141-e4d2-49f1-9768-4ea6e215b37f description: Sample_description notifications: - type: BANDWIDTH_ALERT emails: - someone@sample.com - type: CONNECTION_APPROVAL emails: - someone@sample.com - type: PROFILE_LIFECYCLE emails: - someone@sample.com visibility: PUBLIC tags: - sample_tag allowedEmails: - test@equinix.com - testagain@equinix.com accessPointTypeConfigs: - type: COLO uuid: f20c49cd-b022-4aeb-b3e4-49db4389aff3 supportedBandwidths: - 100 - 500 allowRemoteConnections: false allowCustomBandwidth: true bandwidthAlertThreshold: 10 allowBandwidthAutoApproval: false linkProtocolConfig: encapsulationStrategy: CTAGED reuseVlanSTag: false encapsulation: DOT1Q enableAutoGenerateServiceKey: false connectionRedundancyRequired: false apiConfig: apiAvailable: false equinixManagedPort: true equinixManagedVlan: true allowOverSubscription: false overSubscriptionLimit: 1 bandwidthFromApi: false connectionLabel: true1 authenticationKey: required: false label: Service Key marketingInfo: promotion: true ports: - type: XF_PORT uuid: c791f8cb-5cc9-cc90-8ce0-306a5c00a4ee location: metroCode: SY metros: - code: SY name: Sydney ibxs: - SY4 displayName: Sydney sp-412: value: - errorCode: EQ-3001205 errorMessage: "If-Match : invalid Etag version" getServiceToken: value: href: https://api.equinix.com/fabric/v4/serviceTokens/13ab7dc7-c18e-4f73-aa35-fc3a83966e79 type: VC_TOKEN uuid: 13ab7dc7-c18e-4f73-aa35-fc3a83966e79 name: Az_Aside_Dot1Q_Pri_SV description: Az_Aside_Dot1Q_Pri_SV_Description state: INACTIVE expirationDateTime: 2021-03-18T06:43:49.980Z connection: type: EVPL_VC allowRemoteConnection: false bandwidthLimit: 50 allowCustomBandwidth: false aSide: accessPointSelectors: - type: COLO port: href: https://api.equinix.com/fabric/v4/ports/b840a1db-5758-758f-97e0-328a5c00a874 type: XF_PORT uuid: b840a1db-5758-758f-97e0-328a5c00a874 linkProtocol: type: QINQ vlanCTag: 1399 vlanSTag: 1388 notifications: - type: NOTIFICATION emails: - abc@company.com - provider@company.com account: orgId: 111437 changeLog: createdBy: "843577" createdDateTime: 2021-03-18T06:43:49.980Z updatedBy: "843577" updatedDateTime: 2021-03-18T06:44:14.206Z project: projectId: "995072000433550" getServiceToken-VD: value: href: https://api.equinix.com/fabric/v4/serviceTokens/ea40918e-9b39-4045-8be8-0beaa7eb5ce1 type: VC_TOKEN name: Zside_Virtual_Device_token uuid: ea40918e-9b39-4045-8be8-0beaa7eb5ce1 description: Zside vd token state: INACTIVE connection: type: EVPL_VC allowRemoteConnection: true allowCustomBandwidth: false supportedBandwidths: - 10 - 50 - 200 zSide: accessPointSelectors: - type: VD virtualDevice: name: testVirtualDeviceName type: EDGE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 interface: type: NETWORK uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 id: 45645 project: projectId: 30ad25e2-53dc-11ed-bdc3-0242ac120002 expirationDateTime: 2021-03-18T06:43:49.980Z notifications: - type: NOTIFICATION emails: - abc@company.com account: orgId: 111437 changeLog: createdBy: "843577" createdDateTime: 2021-03-18T06:43:49.980Z updatedBy: "843577" updatedDateTime: 2021-03-18T06:44:14.206Z getServiceToken-Network: value: href: https://api.equinix.com/fabric/v4/serviceTokens/ea40918e-9b39-4045-8be8-0beaa7eb5ce1 type: VC_TOKEN name: Zside_network_token uuid: ea40918e-9b39-4045-8be8-0beaa7eb5ce1 description: Zside Network token state: INACTIVE connection: type: EVPLAN_VC allowRemoteConnection: true allowCustomBandwidth: false bandwidthLimit: 20000 zSide: accessPointSelectors: - type: NETWORK network: href: https://api.equinix.com/fabric/v4/networks/20d32a80-0d61-4333-bc03-707b591ae2f4 type: EVPLAN uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 scope: REGIONAL project: projectId: 30ad25e2-53dc-11ed-bdc3-0242ac120002 expirationDateTime: 2021-03-18T06:43:49.980Z notifications: - type: NOTIFICATION emails: - abc@company.com account: orgId: 111437 changeLog: createdBy: "843577" createdDateTime: 2021-03-18T06:43:49.980Z updatedBy: "843577" updatedDateTime: 2021-03-18T06:44:14.206Z getServiceToken-DryRun: value: href: https://api.equinix.com/fabric/v4/serviceTokens/ea40918e-9b39-4045-8be8-0beaa7eb5ce1 type: VC_TOKEN uuid: ea40918e-9b39-4045-8be8-0beaa7eb5ce1 name: My-Token state: INACTIVE expiryDateTime: 2020-05-31T10:30:00Z connection: type: EVPL_VC bandwidthLimit: 100 allowRemoteConnection: false allowCustomBandwidth: false aSide: accessPointSelectors: - type: COLO port: href: https://api.equinix.com/fabric/v4/ports/b840a1db-5758-758f-97e0-328a5c00a874 type: XF_PORT uuid: b840a1db-5758-758f-97e0-328a5c00a874 linkProtocol: type: QINQ vlanCTag: 1399 vlanSTag: 1388 account: orgId: 111437 notifications: - type: NOTIFICATION emails: - user1@example.com - user2@example.com changeLog: createdBy: 843577 createdDateTime: 2020-05-21T10:30:00Z 400_UUID: value: - errorCode: EQ-3034016 errorMessage: Token not found correlationId: 0963d003-ecda-4391-b166-8ccbf31d2d82 additionalInfo: - property: tokenUuid reason: Token not found UpdateExpirationDate: value: - op: replace path: /expirationDateTime value: 2023-01-20T18:50:34.696Z UpdateTokenName: value: - op: replace path: /name value: Az_Aside_Dot1Q_NewName UpdateTokenDescription: value: - op: replace path: /description value: Az_Aside_Dot1Q_Pri_SV_NewDescription UpdateNotificationEmail: value: - op: replace path: /notifications/emails value: - test1@equinix.com - test2@equinix.com UpdateAsideTokenBandwidth: value: - op: replace path: /connection/bandwidthLimit value: 100 UpdateZsideTokenBandwidth: value: - op: replace path: /connection/supportedBandwidths value: - 50 - 1000 getServiceTokens: value: pagination: offset: 0 limit: 75 total: 2 data: - href: https://api.equinix.com/fabric/v4/serviceTokens/ea40918e-9b39-4045-8be8-0beaa7eb5ce1 type: VC_TOKEN name: zside_network_token uuid: ea40918e-9b39-4045-8be8-0beaa7eb5ce1 description: zside_Network_token connection: type: EVPLAN_VC allowRemoteConnection: true allowCustomBandwidth: false bandwidthLimit: 20000 zSide: accessPointSelectors: - type: NETWORK network: href: https://api.equinix.com/fabric/v4/networks/20d32a80-0d61-4333-bc03-707b591ae2f4 type: EVPLAN uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 scope: REGIONAL project: projectId: 30ad25e2-53dc-11ed-bdc3-0242ac120002 expirationDateTime: 2021-03-18T06:43:49.980Z notifications: - type: NOTIFICATION emails: - abc@company.com - href: https://api.equinix.com/fabric/v4/serviceTokens/ea40918e-9b39-4045-8be8-0beaa7eb5ce1 type: VC_TOKEN name: zside_vd_token uuid: ea40918e-9b39-4045-8be8-0beaa7eb5ce1 description: zside vd token connection: type: EVPL_VC allowRemoteConnection: true allowCustomBandwidth: false supportedBandwidths: - 10 - 50 - 200 zSide: accessPointSelectors: - type: VD virtualDevice: type: EDGE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 interface: type: NETWORK id: 45645 project: projectId: 30ad25e2-53dc-11ed-bdc3-0242ac120002 expirationDateTime: 2021-03-18T06:43:49.980Z notifications: - type: NOTIFICATION emails: - abc@company.com - href: https://api.equinix.com/fabric/v4/serviceTokens/13ab7dc7-c18e-4f73-aa35-fc3a83966e79 type: VC_TOKEN uuid: 13ab7dc7-c18e-4f73-aa35-fc3a83966e79 name: Az_Aside_Dot1Q_Pri_SV description: Az_Aside_Dot1Q_Pri_SV_Description state: INACTIVE expirationDateTime: 2021-03-18T06:43:49.980Z project: projectId: 30ad25e2-53dc-11ed-bdc3-0242ac120002 connection: type: EVPL_VC allowRemoteConnection: false bandwidthLimit: 50 allowCustomBandwidth: false aSide: accessPointSelectors: - type: COLO port: href: https://api.equinix.com/fabric/v4/ports/b840a1db-5758-758f-97e0-328a5c00a874 type: XF_PORT uuid: b840a1db-5758-758f-97e0-328a5c00a874 linkProtocol: type: QINQ vlanCTag: 1399 vlanSTag: 1388 notifications: - type: NOTIFICATION emails: - abc@company.com - provider@company.com account: orgId: 111437 changeLog: createdBy: "843577" createdDateTime: 2021-03-18T06:43:49.980Z updatedBy: "843577" updatedDateTime: 2021-03-18T06:44:14.206Z createServiceTokenWithQnQ: value: type: VC_TOKEN name: Az_Aside_Dot1Q_Pri_SV description: Az_Aside_Dot1Q_Pri_SV_Description expirationDateTime: 2021-03-18T06:43:49.980Z connection: type: EVPL_VC allowRemoteConnection: false bandwidthLimit: 50 allowCustomBandwidth: false aSide: accessPointSelectors: - type: COLO port: uuid: b840a1db-5758-758f-97e0-328a5c00a874 linkProtocol: type: QINQ vlanCTag: 1399 vlanSTag: 1388 notifications: - type: NOTIFICATION emails: - abc@company.com - provider@company.com createServiceTokenWithDot1Q: value: type: VC_TOKEN name: Az_Aside_Dot1Q_Pri_SV description: Az_Aside_Dot1Q_Pri_SV_Description expirationDateTime: 2021-03-18T06:43:49.980Z connection: type: EVPL_VC allowRemoteConnection: false bandwidthLimit: 50 allowCustomBandwidth: false aSide: accessPointSelectors: - type: COLO port: uuid: b840a1db-5758-758f-97e0-328a5c00a874 linkProtocol: type: DOT1Q vlanTag: 1399 notifications: - type: NOTIFICATION emails: - abc@company.com - provider@company.com createServiceTokenWithVxlan: value: type: VC_TOKEN name: Az_Aside_VxLAN_Pri_SV description: Az_Aside_VxLAN_Pri_SV_Description expirationDateTime: 2021-03-18T06:43:49.980Z connection: type: EVPL_VC allowRemoteConnection: true bandwidthLimit: 50 allowCustomBandwidth: false aSide: accessPointSelectors: - type: COLO port: uuid: b840a1db-5758-758f-97e0-328a5c00a874 linkProtocol: type: VXLAN vlanTag: 510000 notifications: - type: NOTIFICATION emails: - abc@company.com - provider@company.com createZsideServiceTokenWithQnQ: value: type: VC_TOKEN name: Az_Zside_Dot1Q_Pri_SV description: Az_Zside_Dot1Q_Pri_SV_Description connection: type: EVPL_VC allowRemoteConnection: true allowCustomBandwidth: false supportedBandwidths: - 10 - 50 - 200 - 500 - 1000 - 2000 - 5000 - 10000 - 25000 - 50000 zSide: accessPointSelectors: - type: COLO port: uuid: b840a1db-5413-413f-97e0-328a5c00a874 linkProtocol: type: QINQ vlanCTag: 1399 vlanSTag: 1388 account: accountNumber: 272010 project: projectId: 30ad25e2-53dc-11ed-bdc3-0242ac120002 expirationDateTime: 2021-03-18T06:43:49.980Z notifications: - type: NOTIFICATION emails: - abc@company.com createZsideServiceTokenWithDot1Q: value: type: VC_TOKEN name: Az_Zside_Dot1Q_Pri_SV description: Az_Zside_Dot1Q_Pri_SV_Description connection: type: EVPL_VC allowRemoteConnection: true allowCustomBandwidth: false supportedBandwidths: - 10 - 50 - 200 - 500 - 1000 - 2000 - 5000 - 10000 - 25000 - 50000 zSide: accessPointSelectors: - type: COLO port: uuid: b840a1db-5413-413f-97e0-328a5c00a874 linkProtocol: type: DOT1Q vlanTag: "3332" expirationDateTime: 2021-03-18T06:43:49.980Z notifications: - type: NOTIFICATION emails: - abc@company.com createZsideServiceTokenWithVxlan: value: type: VC_TOKEN name: Az_Zside_VxLAN_Pri_SV description: Az_Zside_VxLAN_Pri_SV_Description connection: type: EVPL_VC allowRemoteConnection: true allowCustombandwidth: false supportedBandwidths: - 10 - 50 - 200 - 500 - 1000 - 2000 - 5000 - 10000 - 25000 - 50000 zSide: accessPointSelectors: - type: COLO port: uuid: b840a1db-5413-413f-97e0-328a5c00a874 linkProtocol: type: VXLAN vlanTag: "520000" expirationDateTime: 2021-03-18T06:43:49.980Z notifications: - type: NOTIFICATION emails: - abc@company.com createZsideServiceTokenWithVD: value: type: VC_TOKEN name: Zside_VD_token description: zside vd token connection: type: EVPL_VC allowRemoteConnection: true allowCustomBandwidth: false supportedBandwidths: - 10 - 50 - 200 - 10000 zSide: accessPointSelectors: - type: VD virtualDevice: type: EDGE uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 interface: type: NETWORK id: 45645 project: projectId: 30ad25e2-53dc-11ed-bdc3-0242ac120002 expirationDateTime: 2021-03-18T06:43:49.980Z notifications: - type: NOTIFICATION emails: - abc@company.com createZsideServiceTokenWithNetwork: value: type: VC_TOKEN name: zside_Network_token description: Zside_Network_token connection: type: EVPLAN_VC allowRemoteConnection: true supportedBandwidths: - 10 - 50 - 200 zSide: accessPointSelectors: - type: NETWORK network: type: EVPLAN uuid: 20d32a80-0d61-4333-bc03-707b591ae2f4 project: projectId: 30ad25e2-53dc-11ed-bdc3-0242ac120002 expirationDateTime: 2021-03-18T06:43:49.980Z notifications: - type: NOTIFICATION emails: - abc@company.com createServiceTokenDryRunRequest: value: type: VC_TOKEN name: Aside_Dot1Q_Service_Token description: Az_Aside_Dot1Q_DryRun_Description expirationDateTime: 2024-12-18T06:43:49.980Z connection: type: EVPL_VC allowRemoteConnection: false bandwidthLimit: 50 allowCustomBandwidth: false aSide: accessPointSelectors: - type: COLO port: uuid: b840a1db-5758-758f-97e0-328a5c00a874 linkProtocol: type: DOT1Q vlanTag: 1399 notifications: - type: NOTIFICATION emails: - abc@company.com - provider@company.com createZsideServiceTokenWithAsideFCR: value: type: VC_TOKEN name: FCRa_Zside_ServiceToken_SV description: FCRa_Zside_ServiceToken_SV_Description connection: allowRemoteConnection: true allowCustomBandwidth: false supportedBandwidths: - 10 - 50 zSide: accessPointSelectors: - type: COLO hideAssetInfo: false port: uuid: b840a1db-5413-413f-97e0-328a5c00a874 linkProtocol: type: QINQ vlanCTag: 1399 vlanSTag: 1388 account: accountNumber: 272010 project: projectId: 30ad25e2-53dc-11ed-bdc3-0242ac120002 expirationDateTime: 2021-03-18T06:43:49.980Z notifications: - type: NOTIFICATION emails: - abc@company.com createServiceTokenDryRunResponse: value: type: VC_TOKEN name: Aside_Dot1Q_Service_Token description: Az_Aside_Dot1Q_DryRun_Description expirationDateTime: 2024-12-18T06:43:49.980Z connection: type: EVPL_VC allowRemoteConnection: false bandwidthLimit: 50 allowCustomBandwidth: false aSide: accessPointSelectors: - type: COLO port: href: https://api.equinix.com/fabric/v4/ports/b840a1db-5758-758f-97e0-328a5c00a874 uuid: b840a1db-5758-758f-97e0-328a5c00a874 linkProtocol: type: DOT1Q vlanTag: 1399 notifications: - type: NOTIFICATION emails: - abc@company.com - provider@company.com Resend_Service_Token: value: type: RESEND_EMAIL_NOTIFICATION postServiceTokenActionResponse: value: href: https://api.equinix.com/fabric/v4/serviceTokens/13ab7dc7-c18e-4f73-aa35-fc3a83966e79 type: VC_TOKEN uuid: 13ab7dc7-c18e-4f73-aa35-fc3a83966e79 name: Az_Aside_Dot1Q_Pri_SV description: Az_Aside_Dot1Q_Pri_SV_Description state: INACTIVE expiry: 0 expirationDateTime: 2021-03-18T06:43:49.980Z connection: type: EVPL_VC allowRemoteConnection: false bandwidthLimit: 50 allowCustomBandwidth: false aSide: accessPointSelectors: - type: COLO port: href: https://api.equinix.com/fabric/v4/ports/b840a1db-5758-758f-97e0-328a5c00a874 type: XF_PORT uuid: b840a1db-5758-758f-97e0-328a5c00a874 linkProtocol: type: QINQ vlanCTag: 1399 vlanSTag: 1388 notifications: - type: NOTIFICATION emails: - abc@company.com - provider@company.com account: orgId: 111437 changeLog: createdBy: "843577" createdDateTime: 2021-03-18T06:43:49.980Z updatedBy: "843577" updatedDateTime: 2021-03-18T06:44:14.206Z project: projectId: "995072000433550" postServiceTokenSearchUuid: value: filter: and: - property: /uuid operator: = values: - 407f8239-254c-4fe2-a378-458f197e17c4 metro: value: pagination: offset: 0 limit: 75 total: 1 data: - href: https://api.equinix.com/v4/fabric/metros/AM type: XF_METRO code: AM name: Amsterdam region: EMEA equinixAsn: 60000 localVCBandwidthMax: 10000 geoCoordinates: latitude: 52.30049 longitude: 4.942603 connectedMetros: - href: https://api.equinix.com/v4/fabric/metros/MX code: MX avgLatency: 132 remoteVCBandwidthMax: 10000 - href: https://api.equinix.com/v4/fabric/metros/AM code: HH avgLatency: 8.62 remoteVCBandwidthMax: 10000 - href: https://api.equinix.com/v4/fabric/metros/SL code: SL avgLatency: 229 remoteVCBandwidthMax: 10000 - href: https://api.equinix.com/v4/fabric/metros/SO code: SO avgLatency: 36.3 remoteVCBandwidthMax: 50000 - href: https://api.equinix.com/v4/fabric/metros/IL code: IL avgLatency: 44.8 remoteVCBandwidthMax: 50000 - href: https://api.equinix.com/v4/fabric/metros/LS code: LS avgLatency: 36.6 remoteVCBandwidthMax: 50000 - href: https://api.equinix.com/v4/fabric/metros/BA code: BA avgLatency: 32.6 remoteVCBandwidthMax: 50000 - href: https://api.equinix.com/v4/fabric/metros/BL code: BL avgLatency: 3.28 remoteVCBandwidthMax: 50000 - href: https://api.equinix.com/v4/fabric/metros/GV code: GV avgLatency: 15.3 remoteVCBandwidthMax: 50000 - href: https://api.equinix.com/v4/fabric/metros/LD code: LD avgLatency: 5.85 remoteVCBandwidthMax: 50000 400_metros: value: - errorCode: EQ-3036013 errorMessage: Invalid Query Parameter correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 additionalInfo: - property: presence reason: Allowed value for presence is MY_PORTS 401_metros: value: - errorCode: EQ-3036001 errorMessage: Unauthorized correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 additionalInfo: - reason: You are unauthorized to perform this operation 500_metros: value: - errorCode: EQ-3036030 errorMessage: Internal Server Error correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 additionalInfo: - reason: An Internal Server Error occured metroByCode: value: href: https://api.equinix.com/v4/fabric/metros/AM type: XF_METRO code: AM region: EMEA name: Amsterdam equinixAsn: 60000 localVCBandwidthMax: 50000 geoCoordinates: latitude: 52.30049 longitude: 4.942603 connectedMetros: - href: https://api.equinix.com/v4/fabric/metros/MX code: MX avgLatency: 132 remoteVCBandwidthMax: 50000 - href: https://api.equinix.com/v4/fabric/metros/HH code: HH avgLatency: 8.62 remoteVCBandwidthMax: 50000 - href: https://api.equinix.com/v4/fabric/metros/SL code: SL avgLatency: 229 remoteVCBandwidthMax: 50000 - href: https://api.equinix.com/v4/fabric/metros/SO code: SO avgLatency: 36.3 remoteVCBandwidthMax: 10000 - href: https://api.equinix.com/v4/fabric/metros/IL code: IL avgLatency: 44.8 remoteVCBandwidthMax: 10000 - href: https://api.equinix.com/v4/fabric/metros/LS code: LS avgLatency: 36.6 remoteVCBandwidthMax: 10000 - href: https://api.equinix.com/v4/fabric/metros/AM code: BA avgLatency: 32.6 remoteVCBandwidthMax: 10000 - href: https://api.equinix.com/v4/fabric/metros/BL code: BL avgLatency: 3.28 remoteVCBandwidthMax: 10000 - href: https://api.equinix.com/v4/fabric/metros/GV code: GV avgLatency: 15.3 remoteVCBandwidthMax: 10000 - href: https://api.equinix.com/v4/fabric/metros/LD code: LD avgLatency: 5.85 remoteVCBandwidthMax: 10000 400_metroCode: value: - errorCode: EQ-3036013 errorMessage: Invalid Path Parameter correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 additionalInfo: - property: pathparameter-metroCode reason: Provide valid metro code ibxByMetro: value: pagination: offset: 0 limit: 20 total: 1 data: - href: https://api.equinix.com/v4/fabric/metros/AM/ibxs/AM1 type: XF_IBX code: AM1 isTimeServiceEnabled: true ports: value: pagination: offset: 0 limit: 5 total: 1 data: - href: https://api.equinix.com/fabric/v4/ports/e91484bb-4f65-4ab3-8f77-500dec2f855d type: XF_PORT uuid: e91484bb-4f65-4ab3-8f77-500dec2f855d name: test-AT1-Dot1q-L-Secondary-108608 state: ACTIVE bandwidth: 10000 usedBandwidth: 0 availableBandwidth: 20000 physicalPortSpeed: 10000 redundancy: priority: SECONDARY location: metroHref: https://api.equinix.com/fabric/v4/metros/AT ibx: AT1 metroCode: AT metroName: Atlanta region: AMER device: name: dev-m7a2.lab redundancy: group: "1" priority: SECONDARY encapsulation: type: DOT1Q tagProtocolId: 33024 lagEnabled: true package: code: STANDARD type: MSP settings: buyout: false placeVcOrderPermission: true viewPortPermission: true physicalPorts: - state: ACTIVE type: XF_PHYSICAL_PORT id: 6967 bandwidth: 10000 tether: crossConnectId: 100179-A patchPanel: PP:956:66107 patchPanelPortA: "5" patchPanelPortB: "42" operation: operationalStatus: UP - state: ACTIVE type: XF_PHYSICAL_PORT id: 6968 bandwidth: 10000 tether: crossConnectId: 100179-A patchPanel: PP:8118:1586 patchPanelPortA: "92" patchPanelPortB: "24" operation: operationalStatus: UP demarcationPoint: ibx: AT1 patchPanel: PP:8118:1586 patchPanelName: PP:8118:1586 patchPanelPortA: "92" patchPanelPortB: "24" operation: operationalStatus: UP opStatusChangedAt: 2021-06-14T17:21:25.586Z connectionCount: 0 evplVcCount: 0 fgVcCount: 0 accessVcCount: 0 account: accountNumber: 100179 accountName: L2 globalCustId: 007700000090982RG8 orgId: 100179 organizationName: Cust_Org_100179 order: purchaseOrder: startDate: 2020-06-14T17:21:25.586Z endDate: 2020-06-15T17:21:25.586Z type: NEW orderNumber: 1-222078525611 changeLog: createdDateTime: 2020-06-14T17:21:25.586Z project: projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 COLOSinglePortNonLag: value: type: XF_PORT physicalPortsSpeed: 1000 physicalPortsType: 1000BASE_LX connectivitySourceType: COLO location: metroCode: GV demarcationPointIbx: GV1 package: code: STANDARD lagEnabled: false encapsulation: type: DOT1Q tagProtocolId: 33024 project: projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931' account: accountNumber: 270848 notifications: - registeredUsers: - jaguarsuser-port-order type: TECHNICAL order: purchaseOrder: number: 156576 amount: 10 startDate: 2018-06-11T22:25:52.206Z endDate: 2018-07-11T22:25:52.206Z type: NEW signature: signatory: DELEGATE delegate: firstName: John lastName: Doe email: john.doe@company.com physicalPorts: - demarcationPoint: ibx: GV1 cabinetUniqueSpaceId: Demarc cageUniqueSpaceId: GV1:01:002174 patchPanel: CP:Demarc:1259684 connectorType: SC COLOSinglePortLag: value: type: XF_PORT physicalPortsSpeed: 1000 physicalPortsType: 1000BASE_LX connectivitySourceType: COLO location: metroCode: GV demarcationPointIbx: GV1 package: code: STANDARD lagEnabled: true encapsulation: type: DOT1Q tagProtocolId: 33024 project: projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 account: accountNumber: 270848 notifications: - registeredUsers: - jaguarsuser-port-order type: TECHNICAL order: purchaseOrder: number: 156576 amount: 10 startDate: 2018-06-11T22:25:52.206Z endDate: 2018-07-11T22:25:52.206Z type: NEW signature: signatory: DELEGATE delegate: firstName: John lastName: Doe email: john.doe@company.com physicalPorts: - demarcationPoint: ibx: GV1 cabinetUniqueSpaceId: Demarc cageUniqueSpaceId: GV1:01:002174 patchPanel: CP:Demarc:1259684 connectorType: SC COLOLagPortNewGroup: value: type: XF_PORT physicalPortsSpeed: 1000 physicalPortsType: 1000BASE_LX connectivitySourceType: COLO location: metroCode: GV demarcationPointIbx: GV1 package: code: STANDARD lagEnabled: true encapsulation: type: DOT1Q tagProtocolId: 33024 project: projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 account: accountNumber: 270848 notifications: - registeredUsers: - jaguarsuser-port-order type: TECHNICAL order: purchaseOrder: number: 156576 amount: 10 startDate: 2018-06-11T22:25:52.206Z endDate: 2018-07-11T22:25:52.206Z type: NEW signature: signatory: DELEGATE delegate: firstName: John lastName: Doe email: john.doe@company.com physicalPorts: - demarcationPoint: ibx: GV1 cabinetUniqueSpaceId: Demarc cageUniqueSpaceId: GV1:01:002174 patchPanel: CP:Demarc:1259684 connectorType: SC - demarcationPoint: ibx: GV1 cabinetUniqueSpaceId: Demarc cageUniqueSpaceId: GV1:01:002174 patchPanel: CP:Demarc:1259684 connectorType: SC COLOAddSecondaryPort: value: type: XF_PORT physicalPortsSpeed: 10000 physicalPortsType: 1000BASE_LX connectivitySourceType: COLO location: metroCode: GV demarcationPointIbx: GV1 package: code: STANDARD settings: sharedPortType: false sharedPortProduct: null redundancy: priority: SECONDARY group: 1f6bdb37-f131-5925-c039-fe1785fad165 lagEnabled: false encapsulation: type: DOT1Q tagProtocolId: 33024 project: projectId: 567 account: accountNumber: 1000 order: purchaseOrder: number: 156576 amount: 10 startDate: 2018-06-11T22:25:52.206Z endDate: 2018-07-11T22:25:52.206Z type: NEW signature: signatory: DELEGATE delegate: firstName: John lastName: Doe email: john.doe@company.com notifications: - type: TECHNICAL registeredUsers: - jaguarsuser-port-order - type: NOTIFICATION registeredUsers: - jaguarsuser-port-order - type: PEERING registeredUsers: - jaguarsuser-port-order - type: ESCALATION registeredUsers: - jaguarsuser-port-order physicalPorts: - demarcationPoint: ibx: AM1 cabinet: AM1:02:032575:0105 cage: AM1:02:032575 patchPanel: PP:0105:1260379 patchPanelPortA: 14 patchPanelPortB: 15 connectorType: LC REMOTESinglePortNewGroupLagRequest: value: type: XF_PORT physicalPortsSpeed: 1000 physicalPortsType: 1000BASE_LX connectivitySourceType: REMOTE physicalPortsCount: 1 location: metroCode: GV demarcationPointIbx: GV1 settings: packageType: STANDARD sharedPortType: false lagEnabled: true encapsulation: type: DOT1Q tagProtocolId: 33024 project: projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 account: accountNumber: 270848 notifications: - registeredUsers: - jaguarsuser-port-order type: TECHNICAL loas: - uuid: 396e93c2-3b3a-4d47-a9d9-1ea68627374b order: purchaseOrder: number: 156576 amount: 10 startDate: 2018-06-11T22:25:52.206Z endDate: 2018-07-11T22:25:52.206Z type: NEW signature: signatory: DELEGATE delegate: firstName: John lastName: Doe email: john.doe@company.com BMMRSinglePortLag: value: type: XF_PORT physicalPortsSpeed: 1000 physicalPortsType: 1000BASE_LX connectivitySourceType: BMMR bmmrType: SELF physicalPortsCount: 1 location: metroCode: GV demarcationPointIbx: GV1 package: code: STANDARD lagEnabled: true encapsulation: type: DOT1Q tagProtocolId: 33024 project: projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 account: accountNumber: 270848 notifications: - registeredUsers: - jaguarsuser-port-order type: TECHNICAL loas: - uuid: 396e93c2-3b3a-4d47-a9d9-1ea68627374b order: purchaseOrder: number: 156576 amount: 10 startDate: 2018-06-11T22:25:52.206Z endDate: 2018-07-11T22:25:52.206Z type: NEW signature: signatory: DELEGATE delegate: firstName: John lastName: Doe email: john.doe@company.com BMMRSinglePortNoLag: value: type: XF_PORT physicalPortsSpeed: 1000 physicalPortsType: 1000BASE_LX connectivitySourceType: BMMR location: metroCode: GV demarcationPointIbx: GV1 package: code: STANDARD lagEnabled: false encapsulation: type: DOT1Q tagProtocolId: 33024 project: projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 account: accountNumber: 270848 order: purchaseOrder: number: 156576 amount: 10 startDate: 2018-06-11T22:25:52.206Z endDate: 2018-07-11T22:25:52.206Z type: NEW signature: signatory: DELEGATE delegate: firstName: John lastName: Doe email: john.doe@company.com notifications: - registeredUsers: - jaguarsuser-port-order type: TECHNICAL loas: - uuid: f47a6f46-e3f8-430e-9459-bfcc0f54f3c3 - uuid: f47a6f46-e3f8-430e-9459-bfcc0f54f3c4 BMMRAddSecondaryPort: value: type: XF_PORT physicalPortsSpeed: 10000 physicalPortsType: 1000BASE_LX connectivitySourceType: BMMR bmmrType: SELF|EQUINIX location: metroCode: GV demarcationPointIbx: GV1 package: code: STANDARD settings: sharedPortProduct: NETWORK_EDGE redundancy: priority: SECONDARY group: 1f6bdb37-f131-5925-c039-fe1785fad165 lagEnabled: false encapsulation: type: DOT1Q tagProtocolId: 33024 project: projectId: 567 account: accountNumber: 1000 order: purchaseOrder: number: 156576 amount: 10 startDate: 2018-06-11T22:25:52.206Z endDate: 2018-07-11T22:25:52.206Z type: NEW signature: signatory: DELEGATE delegate: firstName: John lastName: Doe email: john.doe@company.com notifications: - type: TECHNICAL registeredUsers: - jaguarsuser-port-order - type: NOTIFICATION registeredUsers: - jaguarsuser-port-order - type: PEERING registeredUsers: - jaguarsuser-port-order - type: ESCALATION registeredUsers: - jaguarsuser-port-order loas: - uuid: f47a6f46-e3f8-430e-9459-bfcc0f54f3c3 - uuid: f47a6f46-e3f8-430e-9459-bfcc0f54f3c4 BMMRLagPortNewGroup: value: type: XF_PORT physicalPortsSpeed: 1000 physicalPortsType: 1000BASE_LX connectivitySourceType: BMMR bmmrType: SELF physicalPortsCount: 1 location: metroCode: GV demarcationPointIbx: GV1 package: code: STANDARD lagEnabled: true encapsulation: type: DOT1Q tagProtocolId: 33024 project: projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 account: accountNumber: 270848 notifications: - registeredUsers: - jaguarsuser-port-order type: TECHNICAL order: purchaseOrder: number: 156576 amount: 10 startDate: 2018-06-11T22:25:52.206Z endDate: 2018-07-11T22:25:52.206Z type: NEW signature: signatory: DELEGATE delegate: firstName: John lastName: Doe email: john.doe@company.com COLOSinglePortNonLagResponse: value: href: https://api.equinix.com/fabric/v4/ports/0f6bdb36-e130-4924-b038-ee1785fad166 type: XF_PORT uuid: 0f6bdb36-e130-4924-b038-ee1785fad166 state: PENDING physicalPortsType: 10GBASE_L physicalPortsSpeed: 10000 physicalPortsCount: 1 location: metroCode: AM demarcationPointIbx: AM1 redundancy: group: 1 priority: PRIMARY lagEnabled: false encapsulation: type: DOT1Q tagProtocolId: 33024 package: code: STANDARD settings: sharedPortType: false project: projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 account: accountNumber: 1000 order: orderNumber: 1-207799950758 signature: signatory: DELEGATE delegate: email: testEmail1@equinix.com notifications: - type: TECHNICAL registeredUsers: - jaguarsuser-port-order - type: NOTIFICATION registeredUsers: - jaguarsuser-port-order - type: PEERING registeredUsers: - jaguarsuser-port-order - type: ESCALATION registeredUsers: - jaguarsuser-port-order port-400: value: - errorCode: EQ-3143101 errorMessage: NOTIFICATION_CONTACT_NOT_VALID details: notifications - errorCode: EQ-3143103 errorMessage: NOTIFICATION_CONTACT_MISSING details: notifications - errorCode: EQ-3143104 errorMessage: ORDERING_CONTACT_MISSING details: notifications - errorCode: EQ-3143105 errorMessage: ORDERING_CONTACT_NOT_VALID details: notifications - errorCode: EQ-3143106 errorMessage: INVALID_PHYSICAL_PORTS details: physicalPorts[%s].Demarcation.cageUniqueSpaceId - errorCode: EQ-3143107 errorMessage: INVALID_PATCH_PANEL_NAME details: physicalPorts[%s].Demarcation.patchPanelName is not valid - errorCode: EQ-3143108 errorMessage: PHYSICAL_PORTS_MISSING details: PhysicalPorts - errorCode: EQ-3143109 errorMessage: ALL_PORTS_USED details: PhysicalPorts.Demarcation.port - errorCode: EQ-3143110 errorMessage: INVALID_PHYSICAL_PORTS_PORTA_DUPLICATE details: PhysicalPorts[%s].Demarcation.portA - errorCode: EQ-3143111 errorMessage: INVALID_PHYSICAL_PORTS_PORTB_DUPLICATE details: PhysicalPorts[%s].Demarcation.portB - errorCode: EQ-3143112 errorMessage: NEXT_AVAIL_CANNOT_BE_TRUE details: PhysicalPorts[%s].Demarcation.portA - errorCode: EQ-3143113 errorMessage: provided metroCode is not available for this user details: metroCode - errorCode: EQ-3143114 errorMessage: MISSING_PORTB details: PhysicalPorts[%s].Demarcation.portB - errorCode: EQ-3143115 errorMessage: PORT_PRIORITY_SHOULD_BE_PRIMARY details: priority - errorCode: EQ-3143116 errorMessage: INVALID_PHYSICAL_PORTS_SPEED details: physicalPortsSpeed - errorCode: EQ-3143117 errorMessage: INVALID_PHYSICAL_PORTS_TYPE details: physicalPortsType - errorCode: EQ-3143118 errorMessage: INVALID_QUOTE_REFERENCE_ID details: quoteReferenceId - errorCode: EQ-3143119 errorMessage: INACTIVE_QUOTE_REFERENCE_ID details: quoteReferenceId - errorCode: EQ-3143120 errorMessage: QUOTE_ORDER_MISMATCHED details: quoteReferenceId - errorCode: EQ-3143121 errorMessage: SHARED_PORT_PRODUCT_INVALID details: sharedPortProduct - errorCode: EQ-3143122 errorMessage: INVALID_USER details: sharedPortType - errorCode: EQ-3143123 errorMessage: INVALID_CONNECTIVITY_SOURCE_TYPE details: ConnectivitySourceType - errorCode: EQ-3143124 errorMessage: ACCOUNT_SERVICE_ERROR details: AccountNumber - errorCode: EQ-3143125 errorMessage: MANDATORY_ATTRIBUTE_ERROR details: PhysicalPorts[%s].Demarcation.portA - errorCode: EQ-3143126 errorMessage: UNTAGGED_INVALID_PACKAGE_TYPE details: settings.packageType - errorCode: EQ-3143127 errorMessage: UNTAGGED_INVALID_ENCAPSULATION details: encapsulation.type - errorCode: EQ-3143128 errorMessage: UNTAGGED_REDUNDANT details: redundancy.priority - errorCode: EQ-3143129 errorMessage: UNTAGGED_LAG details: lagEnabled - errorCode: EQ-3143130 errorMessage: UNTAGGED_SHARED details: settings.sharedPortType - errorCode: EQ-3143131 errorMessage: UNTAGGED_TPID details: encapsulation.tagProtocolId - errorCode: EQ-3143132 errorMessage: PHYSICAL_PORTS_SPEED_NOT_AVAILABLE details: physicalPortsSpeed - errorCode: EQ-3143133 errorMessage: Invalid A side ibx in MC order payload details: ibx - errorCode: EQ-3143134 errorMessage: Invalid Z side ibx in MC order payload details: ibx - errorCode: EQ-3143135 errorMessage: LAG_PORT_WITHOUT_LAG details: lagPort - errorCode: EQ-3143136 errorMessage: LAG_WITH_WITHOUT_LAG details: lag.type - errorCode: EQ-3143137 errorMessage: ORDER_NOT_BELONG_TO_USER - errorCode: EQ-3143138 errorMessage: ORDER_NOT_FOUND port-500: value: - errorCode: EQ-3143001 errorMessage: Please contact support@equinix.com for more info - errorCode: EQ-3143002 errorMessage: Invalid response from order service - errorCode: EQ-3143003 errorMessage: Invalid argument value passed - errorCode: EQ-3143004 errorMessage: Json syntax error, please check request body - errorCode: EQ-3143005 errorMessage: Invalid argument passed - errorCode: EQ-3143006 errorMessage: Method not supported, Please check the URL passed - errorCode: EQ-3143008 errorMessage: virtual Port not found details: connectionDetails[%s].patchPanelName is not valid COLOBulkPort: value: data: - type: XF_PORT name: L2-DEV-USER01-CX-10G-PRIMARY description: Test Redundant port in Amsterdam physicalPortsSpeed: 10000 physicalPortsType: 1000BASE_LX connectivitySourceType: BMMR location: metroCode: AM demarcationPointIbx: AM1 lagEnabled: false encapsulation: type: DOT1Q tagProtocolId: 33024 project: projectId: 567 account: accountNumber: 1000 order: purchaseOrder: number: 156576 amount: 10 startDate: 2018-06-11T22:25:52.206Z endDate: 2018-07-11T22:25:52.206Z type: NEW signature: signatory: DELEGATE delegate: firstName: John lastName: Doe email: john.doe@company.com redundancy: priority: PRIMARY physicalPorts: - demarcationPoint: ibx: AM1 cabinet: AM1:02:032575:0105 cage: AM1:02:032575 patchPanel: PP:0105:1260379 patchPanelPortA: 14 patchPanelPortB: 15 connectorType: LC - type: XF_PORT name: L2-DEV-USER01-CX-10G-SECONDARY description: Test Redundant port in Amsterdam physicalPortsSpeed: 10000 location: metroCode: AM demarcationPointIbx: AM1 lagEnabled: false encapsulation: type: DOT1Q tagProtocolId: 33024 project: projectId: 567 account: accountNumber: 1000 order: purchaseOrder: number: 156576 amount: 10 startDate: 2018-06-11T22:25:52.206Z endDate: 2018-07-11T22:25:52.206Z type: NEW signature: signatory: DELEGATE delegate: firstName: John lastName: Doe email: john.doe@company.com redundancy: priority: SECONDARY physicalPorts: - demarcationPoint: ibx: AM1 cabinet: AM1:02:032575:0105 cage: AM1:02:032575 patchPanel: PP:0105:1260379 patchPanelPortA: 14 patchPanelPortB: 15 connectorType: LC COLOBulkPortResponse: value: data: - href: https://api.equinix.com/fabric/v4/ports/a6f77b33-96c6-4eeb-8d79-76374d950603 uuid: a6f77b33-96c6-4eeb-8d79-76374d950603 physicalPortsSpeed: 1000 physicalPortsType: 1000BASE_LX physicalPortsCount: 1 connectivitySourceType: COLO state: PENDING order: orderNumber: 1-210210611704 account: accountNumber: 270848 changeLog: createdBy: 907831 createdDateTime: 2023-06-02T22:25:52.206Z location: metroCode: GV demarcationPointIbx: GV1 redundancy: group: 22f8e668-4754-4564-825d-d1c7889c885a priority: PRIMARY lagEnabled: false package: code: STANDARD settings: sharedPortType: false project: projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 notifications: - type: TECHNICAL registeredUsers: - jaguarsuser-port-order - type: NOTIFICATION registeredUsers: - jaguarsuser-port-order - href: https://api.equinix.com/fabric/v4/ports/22f8e668-4754-4564-825d-d1c7889c885a uuid: 22f8e668-4754-4564-825d-d1c7889c885a physicalPortsSpeed: 1000 physicalPortsType: 1000BASE_LX physicalPortsCount: 1 connectivitySourceType: COLO state: PENDING order: orderNumber: 1-210210611704 account: accountNumber: 270848 changeLog: createdBy: 907831 createdDateTime: 2023-06-02T22:25:52.206Z location: metroCode: GV demarcationPointIbx: GV1 redundancy: group: a6f77b33-96c6-4eeb-8d79-76374d950603 priority: SECONDARY lagEnabled: false project: projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 package: code: STANDARD settings: sharedPortType: false notifications: - type: TECHNICAL registeredUsers: - jaguarsuser-port-order - type: NOTIFICATION registeredUsers: - jaguarsuser-port-order COLOAddToLag: value: data: - type: XF_PHYSICAL_PORT demarcationPoint: ibx: AM1 cabinetUniqueSpaceId: AM1:02:032575:0105 cageUniqueSpaceId: AM1:02:032575 patchPanel: PP:0105:1260379 patchPanelPortA: 14 patchPanelPortB: 15 connectorType: LC account: accountNumber: 17829 order: purchaseOrder: number: 156576 amount: 10 startDate: 2018-06-11T22:25:52.206Z endDate: 2018-07-11T22:25:52.206Z type: NEW signature: signatory: DELEGATE delegate: firstName: John lastName: Doe email: john.doe@company.com notifications: - registeredUsers: - jaguarsuser-port-order type: NOTIFICATION - type: XF_PHYSICAL_PORT account: accountNumber: 17829 demarcationPoint: ibx: AM1 cabinetUniqueSpaceId: AM1:02:032575:0105 cageUniqueSpaceId: AM1:02:032575 patchPanel: PP:0105:1260379 patchPanelPortA: 16 patchPanelPortB: 17 connectorType: LC order: purchaseOrder: number: 156576 amount: 10 startDate: 2018-06-11T22:25:52.206Z endDate: 2018-07-11T22:25:52.206Z type: NEW signature: signatory: DELEGATE delegate: firstName: John lastName: Doe email: john.doe@company.com notifications: - registeredUsers: - jaguarsuser-port-order type: NOTIFICATION REMOTEAddToLag: value: data: - type: XF_PHYSICAL_PORT order: purchaseOrder: number: 156576 amount: 10 startDate: 2018-06-11T22:25:52.206Z endDate: 2018-07-11T22:25:52.206Z type: NEW signature: signatory: DELEGATE delegate: firstName: John lastName: Doe email: john.doe@company.com account: accountReferenceId: 17829Id - loas: - uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e - type: XF_PHYSICAL_PORT account: accountReferenceId: 17829Id - loas: - uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e BMMRAddToLag: value: data: - type: XF_PHYSICAL_PORT account: accountNumber: 17829 order: purchaseOrder: number: 156576 amount: 10 startDate: 2018-06-11T22:25:52.206Z endDate: 2018-07-11T22:25:52.206Z type: NEW signature: signatory: DELEGATE delegate: firstName: John lastName: Doe email: john.doe@company.com - loas: - uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e - type: XF_PHYSICAL_PORT account: accountNumber: 17829 order: purchaseOrder: number: 156576 amount: 10 startDate: 2018-06-11T22:25:52.206Z endDate: 2018-07-11T22:25:52.206Z type: NEW signature: signatory: DELEGATE delegate: firstName: John lastName: Doe email: john.doe@company.com - loas: - uuid: 64de7e5-7fe7-41e6-b984-80d5aa159a0e COLOAddToLagResponse: value: data: - type: XF_PHYSICAL_PORT demarcationPoint: cabinetUniqueSpaceId: Demarc cageUniqueSpaceId: GV1:01:002174 patchPanel: CP:Demarc:1259684 patchPanelPortA: "39" patchPanelPortB: "40" connectorType: SC ibx: GV1 order: orderNumber: 1-210210611904 notifications: - registeredUsers: - jaguarsuser-port-order type: NOTIFICATION - type: XF_PHYSICAL_PORT demarcationPoint: cabinetUniqueSpaceId: Demarc cageUniqueSpaceId: GV1:01:002174 patchPanel: CP:Demarc:1259684 patchPanelPortA: "41" patchPanelPortB: "42" connectorType: SC ibx: GV1 order: orderNumber: 1-210210611904 notifications: - registeredUsers: - jaguarsuser-port-order type: NOTIFICATION portByUUID: value: href: https://api.equinix.com/fabric/v4/ports/e91484bb-4f65-4ab3-8f77-500dec2f855d type: XF_PORT uuid: e91484bb-4f65-4ab3-8f77-500dec2f855d name: test-AT1-Dot1q-L-Secondary-108608 state: ACTIVE bandwidth: 10000 usedBandwidth: 0 availableBandwidth: 20000 physicalPortsSpeed: 10000 physicalPortsType: 1000BASE_LX connectivitySourceType: COLO redundancy: group: "1" priority: Secondary location: metroHref: https://api.equinix.com/fabric/v4/metros/AT ibx: AT1 metroCode: AT metroName: Atlanta region: AMER device: name: dev-m7a2.lab redundancy: group: "1" priority: Secondary encapsulation: type: DOT1Q tagProtocolId: 33024 lagEnabled: true package: code: STANDARD type: MSP settings: buyout: false placeVcOrderPermission: true viewPortPermission: true physicalPorts: - state: PROVISIONED type: XF_PHYSICAL_PORT id: 6967 bandwidth: 10000 tether: crossConnectId: 100179-A patchPanel: PP:8118:1586 patchPanelPortA: "92" patchPanelPortB: "24" demarcationPoint: ibx: AT1 patchPanel: PP:8118:1586 patchPanelName: PP:8118:1586 patchPanelPortA: "92" patchPanelPortB: "24" - state: PROVISIONED type: XF_PHYSICAL_PORT id: 6968 bandwidth: 10000 tether: crossConnectId: 100179-A patchPanel: PP:8118:1586 patchPanelPortA: "92" patchPanelPortB: "24" operation: operationalStatus: UP opStatusChangedAt: 2021-06-14T17:21:25.586Z connectionCount: 0 evplVcCount: 0 fgVcCount: 0 accessVcCount: 0 account: accountNumber: 100179 accountName: L2 globalCustId: 007700000090982RG8 orgId: 100179 organizationName: Cust_Org_100179 changeLog: createdDateTime: 2018-06-14T17:21:25.587Z project: projectId: 8f23b36f-db8f-44c8-a6e5-606e1b485931 portDelete: value: href: https://api.equinix.com/fabric/v4/ports/e91484bb-4f65-4ab3-8f77-500dec2f855d type: XF_PORT uuid: e91484bb-4f65-4ab3-8f77-500dec2f855d name: test-AT1-Dot1q-L-Secondary-108608 state: DEPROVISIONING bandwidth: 10000 usedBandwidth: 0 availableBandwidth: 20000 redundancy: group: C91484bb-4f65-4ab3-8f77-500dec2f855C priority: PRIMARY location: metroHref: https://api.equinix.com/fabric/v4/metros/AT ibx: AT1 metroCode: AT metroName: Atlanta region: AMER device: name: dev-m7a2.lab redundancy: group: C91484bb-4f65-4ab3-8f77-500dec2f855C priority: PRIMARY encapsulation: type: DOT1Q tagProtocolId: 33024 lagEnabled: true settings: buyout: false placeVcOrderPermission: true viewPortPermission: true physicalPorts: - state: DEPROVISIONING type: XF_PHYSICAL_PORT bandwidth: 10000 tether: crossConnectId: 100179-A patchPanel: PP:8118:1586 patchPanelPortA: "92" patchPanelPortB: "24" demarcationPoint: ibx: AT1 patchPanel: PP:8118:1586 patchPanelName: PP:8118:1586 patchPanelPortA: "92" patchPanelPortB: "24" account: accountNumber: 100179 accountName: L2 account globalCustId: 007700000090982RG8 orgId: 100179 organizationName: Cust_Org_100179 changeLog: createdDateTime: 2018-06-14T17:21:25.587Z PortUpdateNameRequest: value: - op: replace path: /name value: 1234-ibx-port LinkProtocolGetQinqResponseExample: value: pagination: offset: 0 limit: 20 total: 5 data: - type: QINQ uuid: 52d61263-fb0a-459d-a086-bc7fd6bd7384 state: RESERVED vlanSTag: 1000 vlanCTag: 500 asset: href: https://api.equinix.com/fabric/v4/connections/cd67f685-41b0-1b07-6de0-320a5c00abee uuid: cd67f685-41b0-1b07-6de0-320a5c00abee changeLog: createdDateTime: 2020-05-21T10:30:00Z - type: QINQ uuid: 8c589394-b0eb-4057-97dc-3bdb4f8ff6db state: RESERVED vlanSTag: 1000 vlanCTag: 500 serviceToken: href: https://api.equinix.com/fabric/v4/serviceTokens/fc4fb78a-6b89-462d-a233-e75ef61a603f uuid: fc4fb78a-6b89-462d-a233-e75ef61a603f changeLog: createdDateTime: 2020-05-21T10:30:00Z - type: QINQ uuid: 7f1da56d-e1ff-4b25-b542-883c7004e971 state: RESERVED vlanSTag: 1000 vlanCTag: 500 serviceToken: href: https://api.equinix.com/fabric/v4/serviceTokens/90f1af0e-134b-40d6-a007-e62cd6866373 uuid: 90f1af0e-134b-40d6-a007-e62cd6866373 bandwidth: 1000 changeLog: createdDateTime: 2020-05-21T10:30:00Z - type: QINQ uuid: 7c968801-e03b-4530-8424-aa5ecc4339e2 state: RESERVED vlanSTag: 1000 vlanCTag: 500 asset: href: https://api.equinix.com/fabric/v4/connections/2ac4e14f-6120-4705-886e-d37f1d0c6a65 uuid: 2ac4e14f-6120-4705-886e-d37f1d0c6a65 changeLog: createdDateTime: 2020-05-21T10:30:00Z - type: QINQ uuid: db812bba-94b8-43e6-8d9c-850f04350c3d state: RESERVED vlanSTag: 1001 vlanCTag: 1001 asset: href: https://api.equinix.com/fabric/v4/connections/3268d105-e57b-4b2b-8a0a-2e3e42312d95 uuid: 3268d105-e57b-4b2b-8a0a-2e3e42312d95 changeLog: createdDateTime: 2020-05-21T10:30:00Z updatedDateTime: 2020-05-21T10:30:00Z LinkProtocolGetDot1qResponseExample: value: pagination: offset: 5 limit: 20 total: 40 next: /fabric/v4/ports/4ff4047c-7217-4b79-9943-c2c4a2f7324d/linkProtocols?offset=25&limit=20, previous: /fabric/v4/ports/4ff4047c-7217-4b79-9943-c2c4a2f7324d/linkProtocols?offset=0&limit=20 data: - type: DOT1Q uuid: 52d61263-fb0a-459d-a086-bc7fd6bd7384 state: RESERVED vlanTag: 200 asset: href: https://api.equinix.com/fabric/v4/connections/cd67f685-41b0-1b07-6de0-320a5c00abee uuid: cd67f685-41b0-1b07-6de0-320a5c00abee bandwidth: 1000 changeLog: createdDateTime: 2020-05-21T10:30:00Z - type: DOT1Q uuid: 8c589394-b0eb-4057-97dc-3bdb4f8ff6db state: RESERVED vlanTag: 257 serviceToken: href: https://api.equinix.com/fabric/v4/serviceTokens/fc4fb78a-6b89-462d-a233-e75ef61a603f uuid: fc4fb78a-6b89-462d-a233-e75ef61a603f bandwidth: 1000 changeLog: createdDateTime: 2020-05-21T10:30:00Z - type: DOT1Q uuid: 7f1da56d-e1ff-4b25-b542-883c7004e971 state: RESERVED vlanTag: 250 serviceToken: href: https://api.equinix.com/fabric/v4/serviceTokens/90f1af0e-134b-40d6-a007-e62cd6866373 uuid: 90f1af0e-134b-40d6-a007-e62cd6866373 bandwidth: 1000 changeLog: createdDateTime: 2020-05-21T10:30:00Z - type: DOT1Q uuid: 7c968801-e03b-4530-8424-aa5ecc4339e2 state: RESERVED vlanTag: 240 asset: href: https://api.equinix.com/fabric/v4/connections/2ac4e14f-6120-4705-886e-d37f1d0c6a65 uuid: 2ac4e14f-6120-4705-886e-d37f1d0c6a65 bandwidth: 1000 changeLog: createdDateTime: 2020-05-21T10:30:00Z - type: DOT1Q uuid: db812bba-94b8-43e6-8d9c-850f04350c3d state: RESERVED vlanTag: 240 asset: href: https://api.equinix.com/fabric/v4/connections/3268d105-e57b-4b2b-8a0a-2e3e42312d95 uuid: 3268d105-e57b-4b2b-8a0a-2e3e42312d95 bandwidth: 1000 changeLog: createdDateTime: 2020-05-21T10:30:00Z updatedDateTime: 2020-05-21T10:30:00Z LinkProtocolGetVlanRangeResponseExample: value: pagination: offset: 5 limit: 20 total: 40 next: /fabric/v4/ports/4ff4047c-7217-4b79-9943-c2c4a2f7324d/linkProtocols?offset=25&limit=20, previous: /fabric/v4/ports/4ff4047c-7217-4b79-9943-c2c4a2f7324d/linkProtocols?offset=0&limit=20 data: - type: DOT1Q uuid: 52d61263-fb0a-459d-a086-bc7fd6bd7384 state: RESERVED vlanTagMin: 177 vlanTagMax: 179 asset: href: https://api.equinix.com/fabric/v4/connections/cd67f685-41b0-1b07-6de0-320a5c00abee uuid: cd67f685-41b0-1b07-6de0-320a5c00abee bandwidth: 1000 changeLog: createdDateTime: 2020-05-21T10:30:00Z - type: DOT1Q uuid: 8c589394-b0eb-4057-97dc-3bdb4f8ff6db state: RESERVED vlanTagMin: 177 vlanTagMax: 179 serviceToken: href: https://api.equinix.com/fabric/v4/serviceTokens/fc4fb78a-6b89-462d-a233-e75ef61a603f uuid: fc4fb78a-6b89-462d-a233-e75ef61a603f bandwidth: 1000 changeLog: createdDateTime: 2020-05-21T10:30:00Z - type: DOT1Q uuid: 7f1da56d-e1ff-4b25-b542-883c7004e971 state: RESERVED vlanTagMin: 177 vlanTagMax: 179 serviceToken: href: https://api.equinix.com/fabric/v4/serviceTokens/90f1af0e-134b-40d6-a007-e62cd6866373 uuid: 90f1af0e-134b-40d6-a007-e62cd6866373 bandwidth: 1000 changeLog: createdDateTime: 2020-05-21T10:30:00Z - type: DOT1Q uuid: 7c968801-e03b-4530-8424-aa5ecc4339e2 state: RESERVED vlanTagMin: 177 vlanTagMax: 179 asset: href: https://api.equinix.com/fabric/v4/connections/2ac4e14f-6120-4705-886e-d37f1d0c6a65 uuid: 2ac4e14f-6120-4705-886e-d37f1d0c6a65 bandwidth: 1000 changeLog: createdDateTime: 2020-05-21T10:30:00Z - type: DOT1Q uuid: db812bba-94b8-43e6-8d9c-850f04350c3d state: RESERVED vlanTagMin: 177 vlanTagMax: 179 asset: href: https://api.equinix.com/fabric/v4/connections/3268d105-e57b-4b2b-8a0a-2e3e42312d95 uuid: 3268d105-e57b-4b2b-8a0a-2e3e42312d95 bandwidth: 1000 changeLog: createdDateTime: 2020-05-21T10:30:00Z updatedDateTime: 2020-05-21T10:30:00Z 400_invalid_portId: value: - errorCode: EQ-3035202 errorMessage: Unable to fetch port details correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: The uuid requested could not be found in system. Please try again after sometime additionalInfo: property: portUuid 403-port-access: value: - errorCode: EQ-3035002 errorMessage: Access Forbidden correlationId: UnAuthorized User- Cannot perform action PortSearchByProjectId: value: filter: or: - and: - operator: = property: /project/projectId values: - 30ad25e2-53dc-11ed-bdc3-0242ac120002 - operator: = property: /state values: - ACTIVE - operator: = property: /settings/productCode values: - CX pagination: limit: 25 offset: 0 total: 0 sort: - property: /device/name direction: DESC PortSearchByDemarcationIbx: value: filter: - and: - operator: = property: /demarcationPointIbx values: - FR4 - operator: = property: /physicalPortsSpeed values: - 1000 pagination: limit: 5 offset: 0 total: 0 checkCapacity: value: pagination: offset: 0 limit: 5 total: 4 data: - demarcationPointIbx: AM2 tetherIbx: AM2 metroConnectUsed: false lagEnabled: true physicalPortsType: 10GBASE_LR physicalPortsSpeed: 10000 physicalPortsAvailable: 4 redundancy: priority: PRIMARY - demarcationPointIbx: AM2 tetherIbx: AM2 metroConnectUsed: false lagEnabled: true physicalPortsType: 10GBASE_LR physicalPortsSpeed: 10000 physicalPortsAvailable: 8 redundancy: priority: SECONDARY - demarcationPointIbx: AM2 tetherIbx: AM1 metroConnectUsed: true lagEnabled: true physicalPortsType: 10GBASE_L physicalPortsSpeed: 10000 physicalPortsAvailable: 8 redundancy: priority: PRIMARY - demarcationPointIbx: AM2 tetherIbx: AM1 metroConnectUsed: true lagEnabled: true physicalPortsType: 10GBASE_L physicalPortsSpeed: 10000 physicalPortsAvailable: 8 redundancy: priority: SECONDARY ConnectionRouteAggregationsGetAll: value: pagination: offset: 0 limit: 20 total: 4 next: null previous: null data: - 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 - href: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeAggregations/52f7791a-fe90-49bc-8807-18b3d6eda566 type: BGP_IPv6_PREFIX_AGGREGATION uuid: 52f7791a-fe90-49bc-8807-18b3d6eda566 attachmentStatus: ATTACHED - href: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeAggregations/8b67bf1c-7afa-4a9e-98c3-d5ab17da6652 type: BGP_IPv4_PREFIX_AGGREGATION uuid: 8b67bf1c-7afa-4a9e-98c3-d5ab17da6652 attachmentStatus: ATTACHED - href: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeAggregations/65d74639-8f48-4e10-9684-45d364645e97 type: BGP_IPv6_PREFIX_AGGREGATION uuid: 65d74639-8f48-4e10-9684-45d364645e97 attachmentStatus: ATTACHED 400_invalid_input: value: - errorCode: EQ-3044305 errorMessage: Invalid input correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 additionalInfo: - property: type AttachConnectionRouteAggregationsResponse: value: 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 400_transient_state: value: - errorCode: EQ-3044008 errorMessage: Cannot attach or detach route aggregation with connection in transient state correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Cannot attach or detach route aggregation with connection in transient state DetachConnectionRouteAggregationResponse: value: 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 ConnectionRouteFiltersGetAll: value: pagination: offset: 0 limit: 20 total: 4 next: null previous: null data: - href: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d type: BGP_IPv4_PREFIX_FILTER uuid: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d attachmentStatus: DETACHING direction: INBOUND - href: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeFilters/52f7791a-fe90-49bc-8807-18b3d6eda566 type: BGP_IPv6_PREFIX_FILTER uuid: 52f7791a-fe90-49bc-8807-18b3d6eda566 attachmentStatus: ATTACHED direction: INBOUND - href: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeFilters/8b67bf1c-7afa-4a9e-98c3-d5ab17da6652 type: BGP_IPv4_PREFIX_FILTER uuid: 8b67bf1c-7afa-4a9e-98c3-d5ab17da6652 attachmentStatus: ATTACHED direction: OUTBOUND - href: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeFilters/65d74639-8f48-4e10-9684-45d364645e97 type: BGP_IPv6_PREFIX_FILTER uuid: 65d74639-8f48-4e10-9684-45d364645e97 attachmentStatus: ATTACHED direction: OUTBOUND AttachConnectionRouteFiltersResponse: value: href: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d type: BGP_IPv4_PREFIX_FILTER uuid: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d attachmentStatus: ATTACHING direction: INBOUND AttachConnectionRouteFilterInbound: value: direction: INBOUND AttachConnectionRouteFilterOutbound: value: direction: OUTBOUND 400_invalid_direction: value: - errorCode: EQ-3044001 errorMessage: Invalid input correlationId: 20d32a80-0d61-4333-bc03-707b591ae2f5 additionalInfo: - property: direction DetachConnectionRouteFilterInboundResponse: value: href: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d type: BGP_IPv4_PREFIX_FILTER uuid: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d attachmentStatus: DETACHING direction: INBOUND DetachConnectionRouteFilterOutboundResponse: value: href: https://api.equinix.com/fabric/v4/connections/81331c52-04c0-4656-a4a7-18c52669348f/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d type: BGP_IPv4_PREFIX_FILTER uuid: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d attachmentStatus: DETACHING direction: OUTBOUND RouteFilterCreateBgpIpv4Prefix: value: type: BGP_IPv4_PREFIX_FILTER name: My-route-filter-v4 description: Test filter project: projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 notifications: type: ALL emails: - test@equinix.com RouteFilterCreateBgpIpv6Prefix: value: type: BGP_IPv6_PREFIX_FILTER name: My-route-filter-v6 description: Test filter project: projectId: 567 RouteFilterCreateBgpIpv4PrefixResponse: value: href: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d type: BGP_IPv4_PREFIX_FILTER uuid: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d name: My-prefix-filter-v4 description: Test filter state: PROVISIONING change: href: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3 type: BGP_IPv4_PREFIX_FILTER_CREATION uuid: 04af0d37-9160-43d8-97ef-9da9786996a3 notMatchedRuleAction: DENY connectionsCount: 0 project: href: https://api.equinix.com/resourceManager/v1/projects/567 projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 changeLog: createdBy: testuser createdByEmail: testuser@equinix.com createdByFullName: testuser testuser createdDateTime: 2020-05-21T10:30:00Z RouteFilterDeleteBgpIpv4PrefixResponse: value: href: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d type: BGP_IPv4_PREFIX_FILTER uuid: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d name: My-prefix-filter-v4 description: Test filter state: DEPROVISIONING change: href: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/c2ec84c5-6de6-4f5c-b506-3ce218630c31 type: BGP_IPv4_PREFIX_FILTER_DELETION uuid: c2ec84c5-6de6-4f5c-b506-3ce218630c31 notMatchedRuleAction: DENY connectionsCount: 0 project: href: https://api.equinix.com/resourceManager/v1/projects/567 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 400_attached_connection: value: - errorCode: EQ-3044007 errorMessage: Cannot delete route filter still attached to a connection correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Cannot delete route filter still attached to a connection PatchRouteFilterName: value: - op: replace path: /name value: My-route-filter-v4-updated RouteFilterNamePatchResponse: value: href: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d type: BGP_IPv4_PREFIX_FILTER uuid: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d name: My-prefix-filter-v4-updated description: Test filter state: REPROVISIONING change: href: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3 type: BGP_IPv4_PREFIX_FILTER_UPDATE uuid: 04af0d37-9160-43d8-97ef-9da9786996a3 notMatchedRuleAction: DENY connectionsCount: 1 project: href: https://api.equinix.com/resourceManager/v1/projects/567 projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 changeLog: createdBy: testuser createdByEmail: testuser@equinix.com createdByFullName: testuser testuser createdDateTime: 2020-05-21T10:30:00Z 400_invalid_operation: value: - errorCode: EQ-3044011 errorMessage: Invalid argument passed correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Only replace name operation is supported. RouteFilterGetAllChangesResponseExample: value: pagination: offset: 0 limit: 20 total: 4 next: null previous: null data: - href: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3 type: BGP_IPv4_PREFIX_FILTER_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_FILTER name: My-route-filter-v4 description: Test filter project: projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 - href: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3 type: BGP_IPv4_PREFIX_FILTER_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-filter-v4-updated previousValue: My-route-filter-v4 RouteFilterGetChangeResponseExample: value: href: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/changes/04af0d37-9160-43d8-97ef-9da9786996a3 type: BGP_IPv4_PREFIX_FILTER_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_FILTER name: My-route-filter-v4 description: Test filter project: projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 RouteFilterGetConnectionsResponse: value: 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 SearchRouteFiltersRequest: value: filter: and: - property: /type operator: = values: - BGP_IPv4_PREFIX_FILTER - property: /name operator: like values: - "%Route_Filter_Demo%" - property: /project/projectId operator: = values: - dadd3ab6-c0af-430c-8216-43d44f08c1c5 pagination: offset: 1 limit: 2 total: 10 sort: - property: /changeLog/updatedDateTime direction: DESC SearchRouteFiltersResponse: value: pagination: offset: 1 limit: 2 total: 10 next: /routeFilters?offset=3&limit=2 previous: /routeFilters?offset=0&limit=2 data: - href: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d type: BGP_IPv4_PREFIX_FILTER uuid: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d name: My_Route_Filter_Demo_1 description: Test filter state: PROVISIONING notMatchedRuleAction: DENY connectionsCount: 1 project: href: https://api.equinix.com/resourceManager/v1/projects/567 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/routeFilters/795a8471-6595-4ac6-a2f4-b3d96ed3a59d type: BGP_IPv4_PREFIX_FILTER uuid: 695a8471-6595-4ac6-a2f4-b3d96ed3a59d name: My_Route_Filter_Demo_2 description: Test filter state: PROVISIONING notMatchedRuleAction: DENY connectionsCount: 0 project: href: https://api.equinix.com/resourceManager/v1/projects/567 projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 changeLog: createdBy: testuser createdByEmail: testuser@equinix.com createdByFullName: testuser testuser createdDateTime: 2020-05-21T10:30:00Z RouteFilterRulesGetAll: value: pagination: offset: 0 limit: 32 total: 2 next: null previous: null data: - href: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/65b025ef-022b-4180-85cf-82cfc1ab655b type: BGP_IPv4_PREFIX_FILTER_RULE uuid: 65b025ef-022b-4180-85cf-82cfc1ab655b name: Private-subnet-filter-2 description: Test rule prefixMatch: exact action: PERMIT prefix: 192.168.10.0/24 state: PROVISIONED change: href: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403/changes/9397f111-19aa-489c-b3c7-349c86818f2d type: IPv4_BGP_PREFIX_FILTER_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/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/ea48337b-fe04-4164-a3f0-48d81abf575b type: BGP_IPv4_PREFIX_FILTER_RULE uuid: ea48337b-fe04-4164-a3f0-48d81abf575b name: Private-subnet-filter-2 description: Test rule prefixMatch: orlonger action: PERMIT prefix: 192.168.20.0/24 state: PROVISIONED change: href: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403/changes/9397f111-19aa-489c-b3c7-349c86818f2d type: IPv4_BGP_PREFIX_FILTER_RULE_CREATION uuid: 9397f111-19aa-489c-b3c7-349c86818f2d changeLog: createdBy: testuser createdByEmail: testuser@equinix.com createdByFullName: testuser testuser createdDateTime: 2020-05-21T10:30:00Z RouteFilterRuleCreateBgpIpv4Prefix: value: name: Private-subnet-filter description: Test rule prefix: 192.168.0.0/24 prefixMatch: exact RouteFilterRuleCreateBgpIpv6Prefix: value: name: Private-subnet-filter description: Test rule prefix: 2001:7a9::34f4:0:f3dd:1/126 prefixMatch: orlonger RouteFilterRuleCreateBgpIpv4PrefixResponse: value: href: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403 type: BGP_IPv4_PREFIX_FILTER_RULE uuid: 9890d520-1579-4489-8003-154b34b8f403 name: Private-subnet-filter state: PROVISIONING description: Test rule change: href: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403/changes/ff9653dc-88c5-47b5-b552-8a08d2f73f7e type: BGP_IPv4_PREFIX_FILTER_RULE_CREATION uuid: ff9653dc-88c5-47b5-b552-8a08d2f73f7e action: PERMIT prefix: 192.168.0.0/24 prefixMatch: exact 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 RouteFilterRuleCreateBgpIpv6PrefixResponse: value: href: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403 type: BGP_IPv6_PREFIX_FILTER_RULE uuid: 9890d520-1579-4489-8003-154b34b8f403 name: Private-subnet-filter description: Test rule state: PROVISIONING change: href: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403/changes/ff9653dc-88c5-47b5-b552-8a08d2f73f7e type: BGP_IPv6_PREFIX_FILTER_RULE_CREATION uuid: ff9653dc-88c5-47b5-b552-8a08d2f73f7e action: PERMIT prefix: 2001:7a9::34f4:0:f3dd:1/126 prefixMatch: exact 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 400_bad_request: value: - errorCode: EQ-3044013 errorMessage: Invalid argument value passed property: prefixMatch correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec UpdateRouteFilterRuleIPv4: value: name: Private-subnet-filter-update description: Test rule prefix: 192.168.0.0/24 prefixMatch: exact UpdateRouteFilterRuleIPv6: value: name: Private-subnet-filter-update description: Test rule prefix: 2001:7a9::34f4:0:f3dd:1/126 prefixMatch: exact RouteFilterRuleReplaceIpv4Response: value: href: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403 type: BGP_IPv4_PREFIX_FILTER_RULE uuid: 9890d520-1579-4489-8003-154b34b8f403 name: Private-subnet-filter-update description: Test rule prefixMatch: exact state: REPROVISIONING action: PERMIT change: href: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403/changes/a25ca469-721a-4614-89a9-cdef287aa628 type: BGP_IPv4_PREFIX_FILTER_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 RouteFilterRuleReplaceIpv6Response: value: href: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403 type: BGP_IPv6_PREFIX_FILTER_RULE uuid: 9890d520-1579-4489-8003-154b34b8f403 name: Private-subnet-filter-update description: Test rule prefixMatch: exact state: REPROVISIONING action: PERMIT change: href: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403/changes/a25ca469-721a-4614-89a9-cdef287aa628 type: BGP_IPv6_PREFIX_FILTER_RULE_UPDATE uuid: a25ca469-721a-4614-89a9-cdef287aa628 prefix: 2001:7a9::34f4:0:f3dd:1/128 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 RouteFilterRuleDeleteBgpIpv4PrefixResponse: value: href: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403 type: BGP_IPv4_PREFIX_FILTER_RULE uuid: 9890d520-1579-4489-8003-154b34b8f403 name: Private-subnet-filter description: Test rule state: DEPROVISIONING change: href: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403/changes/e8528788-14d3-4a7b-a740-99b702067485 type: BGP_IPv4_PREFIX_FILTER_RULE_DELETION uuid: e8528788-14d3-4a7b-a740-99b702067485 action: PERMIT prefix: 192.168.0.0/24 prefixMatch: exact 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 RouteFilterRuleDeleteBgpIpv6PrefixResponse: value: href: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403 type: BGP_IPv6_PREFIX_FILTER_RULE uuid: 9890d520-1579-4489-8003-154b34b8f403 name: Private-subnet-filter description: Test rule state: REPROVISIONING change: href: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403/changes/e8528788-14d3-4a7b-a740-99b702067485 type: BGP_IPv6_PREFIX_FILTER_RULE_DELETION uuid: e8528788-14d3-4a7b-a740-99b702067485 action: PERMIT prefix: 2001:7a9::34f4:0:f3dd:1/126 prefixMatch: exact 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 400_transient_filter: value: - errorCode: EQ-3044215 errorMessage: Cannot delete route filter rule in transient state correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Cannot delete route filter rule in transient state PatchRouteFilterRuleName: value: - op: replace path: /name value: test-route-filter-name-patch PatchRouteFilterRulePrefix: value: - op: replace path: /prefix value: 192.168.0.0/30 PatchRouteFilterRulePrefixMatch: value: - op: replace path: /prefixMatch value: orlonger RouteFilterRulesGetAllChangesResponseExample: value: pagination: offset: 0 limit: 20 total: 3 next: null previous: null data: - href: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403/changes/ff9653dc-88c5-47b5-b552-8a08d2f73f7e type: BGP_IPv4_PREFIX_FILTER_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_FILTER_RULE name: Private-subnet-filter description: Test rule prefix: 192.168.0.0/25 prefixMatch: exact action: PERMIT - href: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403/changes/a40085a4-f0cc-416c-af01-286f7f7ec736 type: BGP_IPv4_PREFIX_FILTER_RULE_UPDATE uuid: a40085a4-f0cc-416c-af01-286f7f7ec736 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: /prefixMatch value: orlonger previousValue: exact - href: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403/changes/a25ca469-721a-4614-89a9-cdef287aa628 type: BGP_IPv4_PREFIX_FILTER_RULE_UPDATE uuid: a25ca469-721a-4614-89a9-cdef287aa628 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: /prefixMatch value: exact previousValue: orlonger RouteFilterRuleGetChangeResponseExample: value: href: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403/changes/ff9653dc-88c5-47b5-b552-8a08d2f73f7e type: BGP_IPv4_PREFIX_FILTER_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_FILTER_RULE name: Private-subnet-filter description: Test rule prefix: 192.168.0.0/25 prefixMatch: exact action: PERMIT RouteFilterRulesBulkResponse: value: pagination: offset: 0 limit: 32 total: 2 next: null previous: null data: - href: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/65b025ef-022b-4180-85cf-82cfc1ab655b type: BGP_IPv4_PREFIX_FILTER_RULE uuid: 65b025ef-022b-4180-85cf-82cfc1ab655b name: Private-subnet-filter-2 description: Test rule prefixMatch: exact action: PERMIT prefix: 192.168.10.0/24 state: PROVISIONING change: href: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403/changes/9397f111-19aa-489c-b3c7-349c86818f2d type: IPv4_BGP_PREFIX_FILTER_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/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/ea48337b-fe04-4164-a3f0-48d81abf575b type: BGP_IPv4_PREFIX_FILTER_RULE uuid: ea48337b-fe04-4164-a3f0-48d81abf575b name: Private-subnet-filter-2 description: Test rule prefixMatch: orlonger action: PERMIT prefix: 192.168.20.0/24 state: PROVISIONING change: href: https://api.equinix.com/fabric/v4/routeFilters/695a8471-6595-4ac6-a2f4-b3d96ed3a59d/routeFilterRules/9890d520-1579-4489-8003-154b34b8f403/changes/9397f111-19aa-489c-b3c7-349c86818f2d type: IPv4_BGP_PREFIX_FILTER_RULE_CREATION uuid: 9397f111-19aa-489c-b3c7-349c86818f2d changeLog: createdBy: testuser createdByEmail: testuser@equinix.com createdByFullName: testuser testuser createdDateTime: 2020-05-21T10:30:00Z RouteAggregationCreateBgpIpv4Prefix: value: type: BGP_IPv4_PREFIX_AGGREGATION name: My-route-aggregation-v4 description: Test aggregation project: projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 RouteAggregationCreateBgpIpv4PrefixResponse: value: 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 RouteAggregationDeleteBgpIpv4PrefixResponse: value: 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 PatchRouteAggregationName: value: - op: replace path: /name value: My-route-aggregation-v4-updated RouteAggregationNamePatchResponse: value: 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 RouteAggregationGetAllChangesResponseExample: value: 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 RouteAggregationGetChangeResponseExample: value: 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 RouteAggregationGetConnectionsResponse: value: 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 SearchRouteAggregationsRequest: value: 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 SearchRouteAggregationsResponse: value: 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 RouteAggregationRulesGetAll: value: 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 RouteAggregationRuleCreateBgpIpv4Prefix: value: name: Private-subnet-aggregation description: Test rule prefix: 192.168.0.0/24 RouteAggregationRuleCreateBgpIpv4PrefixResponse: value: 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 UpdateRouteAggregationRuleIPv4: value: name: Private-subnet-aggregation-update description: Test rule prefix: 192.168.0.0/24 RouteAggregationRuleReplaceIpv4Response: value: 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 RouteAggregationRuleDeleteBgpIpv4PrefixResponse: value: 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 400_transient_aggregation: value: - errorCode: EQ-3044415 errorMessage: Cannot delete route aggregation rule, route aggregation in transient state correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Cannot delete route aggregation rule, route aggregation is in transient state PatchRouteAggregationRuleName: value: - op: replace path: /name value: test-route-aggregation-name-patch PatchRouteAggregationRulePrefix: value: - op: replace path: /prefix value: 192.168.0.0/30 RouteAggregationRulesGetAllChangesResponseExample: value: 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 RouteAggregationRuleGetChangeResponseExample: value: 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 RouteAggregationRulesBulkResponse: value: 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 CreateLabPackage: value: type: XF_ROUTER name: My-Cloud-Router location: metroCode: SV package: code: LAB notifications: - type: ALL emails: - test@test.com account: accountNumber: 272010 project: projectId: "995072000433550" CreateStandardPackage: value: type: XF_ROUTER name: My-Cloud-Router location: metroCode: SV package: code: STANDARD notifications: - type: ALL emails: - test@test.com account: accountNumber: 272010 project: projectId: "995072000433550" CreateWithMarketplaceSubscription: value: type: XF_ROUTER name: My-Cloud-Router location: metroCode: SV package: code: ADVANCED notifications: - type: ALL emails: - test@test.com project: projectId: ae708bbb-d669-406a-845a-99b39ff65fd0 marketplaceSubscription: uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 CloudRouterPostResponseExample: value: href: https://api.equinix.com/fabric/v4/routers/201b7346-a9eb-42fe-ae7a-08148c71928d uuid: 201b7346-a9eb-42fe-ae7a-08148c71928d state: PROVISIONED type: XF_ROUTER name: My-Cloud-Router location: metroHref: https://api.equinix.com/fabric/v4/metros/HH metroCode: HH equinixAsn: 30000 package: href: https://api.equinix.com/fabric/v4/routerPackages/STANDARD code: STANDARD order: purchaseOrderNumber: 1-129105284100 project: projectId: "12345" notifications: - type: ALL emails: - abc@abc.com account: accountNumber: 123 connectionsCount: 0 changeLog: createdBy: abc@xyz.com createdByFullName: abc createdByEmail: abc@xyz.com createdDateTime: 2021-09-24T06:59:46Z CloudRouterPostResponseMarketplaceExample: value: href: https://api.equinix.com/fabric/v4/routers/201b7346-a9eb-42fe-ae7a-08148c71928d uuid: 201b7346-a9eb-42fe-ae7a-08148c71928d state: PROVISIONED type: XF_ROUTER name: My-Cloud-Router location: metroHref: https://api.equinix.com/fabric/v4/metros/HH metroCode: HH equinixAsn: 30000 package: href: https://api.equinix.com/fabric/v4/routerPackages/STANDARD code: STANDARD project: projectId: ae708bbb-d669-406a-845a-99b39ff65fd0 notifications: - type: ALL emails: - abc@abc.com connectionsCount: 0 marketplaceSubscription: href: https://api.equinix.com/fabric/v4/marketplaceSubscriptions/20d32a80-0d61-4333-bc03-707b591ae2f5 type: AWS_MARKETPLACE_SUBSCRIPTION uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 changeLog: createdBy: abc@xyz.com createdByFullName: abc createdByEmail: abc@xyz.com createdDateTime: 2021-09-24T06:59:46Z CloudRouterResponseExampleDryRun: value: type: XF_ROUTER name: My-Cloud-Router location: metroHref: https://api.equinix.com/fabric/v4/metros/SV metroCode: SV package: href: https://api.equinix.com/fabric/v4/routerPackages/STANDARD code: STANDARD project: projectId: e1c94b73-1be8-44d5-b577-99bbf67249a4 notifications: - type: ALL emails: - abc@abc.com account: accountNumber: 123 400_invalid_package: value: - errorCode: EQ-3040028 errorMessage: Package not found correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: package must be of type LAB or PRO 400_invalid_name: value: - errorCode: EQ-3040022 errorMessage: Name is minimum 3 and up to 24 characters in length correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Name is minimum 3 and up to 24 characters in length additionalInfo: - property: /name reason: Name is minimum 3 and up to 24 characters in length 400_invalid_account: value: - errorCode: EQ-3040032 errorMessage: Invalid account number correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Invalid account number additionalInfo: - property: /account/accountNumber reason: Invalid project account number 400_max_lab_fcr_demo: value: - errorCode: EQ-3040060 errorMessage: Create request rejected correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Only 3 Lab Fabric Cloud Routers allowed per Organization CloudRouterResponseExample: value: href: https://api.equinix.com/fabric/v4/routers/201b7346-a9eb-42fe-ae7a-08148c71928d uuid: 201b7346-a9eb-42fe-ae7a-08148c71928d state: PROVISIONED type: XF_ROUTER name: My-Cloud-Router location: metroHref: https://api.equinix.com/fabric/v4/metros/HH metroCode: HH equinixAsn: 30000 package: href: https://api.equinix.com/fabric/v4/routerPackages/STANDARD code: STANDARD order: purchaseOrderNumber: 1-129105284100 project: projectId: ae708bbb-d669-406a-845a-99b39ff65fd0 notifications: - type: ALL emails: - abc@abc.com account: accountNumber: 123 connectionsCount: 0 changeLog: createdBy: abc@xyz.com createdByFullName: abc createdByEmail: abc@xyz.com createdDateTime: 2021-09-24T06:59:46Z updatedBy: abc@xyz.com updatedByFullName: abc updatedByEmail: abc@xyz.com updatedDateTime: 2021-09-24T06:59:46Z deletedBy: abc@xyz.com deletedByFullName: abc deletedByEmail: abc@xyz.com deletedDateTime: 2021-09-24T06:59:46Z CloudRouterResponseExampleMarketplace: value: href: https://api.equinix.com/fabric/v4/routers/201b7346-a9eb-42fe-ae7a-08148c71928d uuid: 201b7346-a9eb-42fe-ae7a-08148c71928d state: PROVISIONED type: XF_ROUTER name: My-Cloud-Router location: metroHref: https://api.equinix.com/fabric/v4/metros/HH metroCode: HH equinixAsn: 30000 package: href: https://api.equinix.com/fabric/v4/routerPackages/STANDARD code: STANDARD project: projectId: ae708bbb-d669-406a-845a-99b39ff65fd0 notifications: - type: ALL emails: - abc@abc.com connectionsCount: 0 marketplaceSubscription: href: https://api.equinix.com/fabric/v4/marketplaceSubscriptions/20d32a80-0d61-4333-bc03-707b591ae2f5 type: AWS_MARKETPLACE_SUBSCRIPTION uuid: 20d32a80-0d61-4333-bc03-707b591ae2f5 changeLog: createdBy: abc@xyz.com createdByFullName: abc createdByEmail: abc@xyz.com createdDateTime: 2021-09-24T06:59:46Z updatedBy: abc@xyz.com updatedByFullName: abc updatedByEmail: abc@xyz.com updatedDateTime: 2021-09-24T06:59:46Z 400_invalid_state: value: - errorCode: EQ-3040030 errorMessage: Cannot delete Fabric Cloud Router in transient state correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Cannot delete Fabric Cloud Router in transient state. UpdatePackage: value: - op: replace path: /package/code value: PREMIUM UpdateName: value: - op: replace path: /name value: Router-name-2 UpdateNotifications: value: - op: replace path: /notifications value: - type: ALL emails: - testEmail1@equinix.com - testEmail2@equinix.com CloudRouterPatchResponseExample: value: href: https://api.equinix.com/fabric/v4/routers/201b7346-a9eb-42fe-ae7a-08148c71928d uuid: 201b7346-a9eb-42fe-ae7a-08148c71928d state: PROVISIONED type: XF_ROUTER name: My-Cloud-Router location: metroHref: https://api.equinix.com/fabric/v4/metros/HH metroCode: HH equinixAsn: 30000 package: href: https://api.equinix.com/fabric/v4/routerPackages/STANDARD code: STANDARD order: purchaseOrderNumber: 1-129105284100 project: projectId: "123456" notifications: - type: ALL emails: - abc@abc.com account: accountNumber: 123 connectionsCount: 0 change: uuid: 3c9b8e7a2-f3b1-4576-a4a9-1366a63df170 type: ROUTER_UPDATE status: REQUESTED createdDateTime: 2022-04-19T04:20:55.471Z updatedDateTime: 2022-04-19T04:20:55.471Z changeLog: createdBy: abc@xyz.com createdByFullName: abc createdByEmail: abc@xyz.com createdDateTime: 2021-09-24T06:59:46Z updatedBy: abc@xyz.com updatedByFullName: abc updatedByEmail: abc@xyz.com updatedDateTime: 2021-09-24T06:59:46Z deletedBy: abc@xyz.com deletedByFullName: abc deletedByEmail: abc@xyz.com deletedDateTime: 2021-09-24T06:59:46Z CloudRouterActionResponse: value: type: ROUTE_TABLE_ENTRY_UPDATE uuid: 37c10edc-ba2e-4240-a850-8a48f9c47d00 state: PENDING changeLog: createdDateTime: 2020-05-21T10:30:00Z RouteEntriesStatusUpdate: value: type: ROUTE_TABLE_ENTRY_UPDATE ReceivedRouteEntriesStatusUpdate: value: type: RECEIVED_ROUTE_ENTRY_UPDATE AdvertisedRouteEntriesStatusUpdate: value: type: ADVERTISED_ROUTE_ENTRY_UPDATE connection: uuid: 557400f8-d360-11e9-bb65-2a2ae2dbcce4 CloudRouterReceivedRoutesActionResponse: value: type: RECEIVED_ROUTE_ENTRY_UPDATE uuid: 37c10edc-ba2e-4240-a850-8a48f9c47d01 state: PENDING connection: uuid: 3066ab1d-af87-49d7-8a14-c9bdb57ac809 changeLog: createdDateTime: 2020-05-21T10:30:00Z CloudRouterAdvertisedRoutesActionResponse: value: type: ADVERTISED_ROUTE_ENTRY_UPDATE uuid: 37c10edc-ba2e-4240-a850-8a48f9c47d01 state: PENDING connection: uuid: 3066ab1d-af87-49d7-8a14-c9bdb57ac809 changeLog: createdDateTime: 2020-05-21T10:30:00Z CloudRouterActionsSearchByType: value: filter: and: - property: /type operator: = values: - ROUTE_TABLE_ENTRY_UPDATE pagination: offset: 0 limit: 20 sort: - direction: DESC property: /changeLog/createdDateTime 400_invalid_sorting: value: - errorCode: EQ-3043015 errorMessage: Invalid value for sorting direction. correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec additionalInfo: - reason: Only accept DESC and ASC for sorting direction. GetAllPingCommandResponse: value: pagination: offset: 20 limit: 20 total: 100 next: /search?offset=40&limit=20 previous: /search?offset=0&limit=20 data: href: https://api.equinix.com/fabric/v4/routers/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81/commands/37c10edc-ba2e-4240-a850-8a48f9c47d00 type: PING_COMMAND uuid: 37c10edc-ba2e-4240-a850-8a48f9c47d00 name: ping-test-1 description: Testing FCR-SV-1 state: SUCCEEDED project: projectId: b11d4cb5-978a-418a-8b13-bf19abb97938 request: destination: 8.8.8.8 sourceConnection: uuid: 1da3778c-6aa3-4e47-b2fe-83a0773dde18 timeout: 5 dataBytes: 100 count: 5 interval: 1000 response: output: "PING 8.8.8.8 (8.8.8.8): 100 data bytes\n108 bytes from 8.8.8.8: icmp_seq=0 ttl=117 time=9.839 ms\n108 bytes from 8.8.8.8: icmp_seq=1 ttl=117 time=16.051 ms\n108 bytes from 8.8.8.8: icmp_seq=2 ttl=117 time=9.271 ms\n108 bytes from 8.8.8.8: icmp_seq=3 ttl=117 time=26.771 ms \n--- 8.8.8.8 ping statistics ---\n4 packets transmitted, 4 packets received, 0.0% packet loss\nround-trip min/avg/max/stddev = 9.271/15.483/26.771/7.039 ms" outputStructuredPing: destinationIp: 8.8.8.8 destinationName: 8.8.8.8 dataBytes: 100 packetsTransmitted: 4 packetsReceived: 4 packetsLossPercent: 0 rttMin: 9.271 rttAvg: 15.483 rttMax: 26.771 rttStdDev: 7.039 responses: - bytes: 100 ip: 8.8.8.8 icmpSeq: 0 ttl: 117 time: 9.839 - bytes: 100 ip: 8.8.8.8 icmpSeq: 1 ttl: 117 time: 16.051 - bytes: 100 ip: 8.8.8.8 icmpSeq: 2 ttl: 117 time: 9.271 - bytes: 100 ip: 8.8.8.8 icmpSeq: 3 ttl: 117 time: 26.771 changeLog: createdBy: testuser createdDateTime: 2020-05-21T10:30:00Z 400_invalid_operation_commands: value: - errorCode: EQ-3043002 errorMessage: Invalid argument passed correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec details: Invalid argument passed 403_commands: value: - errorCode: EQ-3043006 errorMessage: The system is unable to process your request. correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec details: The system is unable to process your request. 404_commands: value: - errorCode: EQ-3043022 errorMessage: Cloud router command not found correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec details: Cloud router command not found 415_commands: value: - errorCode: EQ-3043029 errorMessage: Unsupported media type correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec details: Content type application/json not supported. 500_commands: value: - errorCode: EQ-3043005 errorMessage: Internal server error correlationId: cebc3d33-9037-4a2b-a7af-0ad65602cdec details: Internal server error PostRequestPingCommand: value: type: PING_COMMAND name: ping-test-1 description: Testing FCR-SV-1 project: projectId: b11d4cb5-978a-418a-8b13-bf19abb97938 request: destination: 8.8.8.8 sourceConnection: uuid: 1da3778c-6aa3-4e47-b2fe-83a0773dde18 timeout: 2 dataBytes: 100 PostResponsePingCommand: value: href: https://api.equinix.com/fabric/v4/routers/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81/commands/37c10edc-ba2e-4240-a850-8a48f9c47d00 type: PING_COMMAND uuid: 37c10edc-ba2e-4240-a850-8a48f9c47d00 name: ping-test-1 description: Testing FCR-SV-1 state: PENDING project: projectId: b11d4cb5-978a-418a-8b13-bf19abb97938 request: destination: 8.8.8.8 sourceConnection: uuid: 1da3778c-6aa3-4e47-b2fe-83a0773dde18 timeout: 2 dataBytes: 100 count: 5 interval: 1000 changeLog: createdBy: testuser createdDateTime: 2020-05-21T10:30:00Z SearchByStateRequest: value: filter: and: - property: /state operator: = values: - SUCCEEDED pagination: offset: 0 limit: 20 sort: - direction: DESC property: /changeLog/createdDateTime SearchResponse: value: pagination: offset: 20 limit: 20 total: 100 next: /search?offset=40&limit=20 previous: /search?offset=0&limit=20 data: href: https://api.equinix.com/fabric/v4/routers/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81/commands/37c10edc-ba2e-4240-a850-8a48f9c47d00 type: PING_COMMAND uuid: 37c10edc-ba2e-4240-a850-8a48f9c47d00 name: ping-test-1 description: Testing FCR-SV-1 state: SUCCEEDED project: projectId: b11d4cb5-978a-418a-8b13-bf19abb97938 request: destination: 8.8.8.8 sourceConnection: uuid: 1da3778c-6aa3-4e47-b2fe-83a0773dde18 timeout: 2 dataBytes: 100 count: 5 interval: 1000 response: output: "PING 8.8.8.8 (8.8.8.8): 100 data bytes\n108 bytes from 8.8.8.8: icmp_seq=0 ttl=117 time=9.839 ms\n108 bytes from 8.8.8.8: icmp_seq=1 ttl=117 time=16.051 ms\n108 bytes from 8.8.8.8: icmp_seq=2 ttl=117 time=9.271 ms\n108 bytes from 8.8.8.8: icmp_seq=3 ttl=117 time=26.771 ms \n--- 8.8.8.8 ping statistics ---\n4 packets transmitted, 4 packets received, 0.0% packet loss\nround-trip min/avg/max/stddev = 9.271/15.483/26.771/7.039 ms" outputStructuredPing: destinationIp: 8.8.8.8 destinationName: 8.8.8.8 dataBytes: 100 packetsTransmitted: 4 packetsReceived: 4 packetsLossPercent: 0 rttMin: 9.271 rttAvg: 15.483 rttMax: 26.771 rttStdDev: 7.039 responses: - bytes: 100 ip: 8.8.8.8 icmpSeq: 0 ttl: 117 time: 9.839 - bytes: 100 ip: 8.8.8.8 icmpSeq: 1 ttl: 117 time: 16.051 - bytes: 100 ip: 8.8.8.8 icmpSeq: 2 ttl: 117 time: 9.271 - bytes: 100 ip: 8.8.8.8 icmpSeq: 3 ttl: 117 time: 26.771 changeLog: createdBy: testuser createdDateTime: 2020-05-21T10:30:00Z 400_invalid_sorting_commands: value: - errorCode: EQ-3043015 errorMessage: Invalid value for sorting direction. correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 additionalInfo: - reason: Only accept DESC and ASC for sorting direction. GetResponsePingCommand: value: href: https://api.equinix.com/fabric/v4/routers/9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81/commands/37c10edc-ba2e-4240-a850-8a48f9c47d00 type: PING_COMMAND uuid: 37c10edc-ba2e-4240-a850-8a48f9c47d00 name: ping-test-1 description: Testing FCR-SV-1 state: SUCCEEDED project: projectId: b11d4cb5-978a-418a-8b13-bf19abb97938 request: destination: 8.8.8.8 sourceConnection: uuid: 1da3778c-6aa3-4e47-b2fe-83a0773dde18 timeout: 2 dataBytes: 100 count: 5 interval: 1000 response: output: "PING 8.8.8.8 (8.8.8.8): 100 data bytes\n108 bytes from 8.8.8.8: icmp_seq=0 ttl=117 time=9.839 ms\n108 bytes from 8.8.8.8: icmp_seq=1 ttl=117 time=16.051 ms\n108 bytes from 8.8.8.8: icmp_seq=2 ttl=117 time=9.271 ms\n108 bytes from 8.8.8.8: icmp_seq=3 ttl=117 time=26.771 ms \n--- 8.8.8.8 ping statistics ---\n4 packets transmitted, 4 packets received, 0.0% packet loss\nround-trip min/avg/max/stddev = 9.271/15.483/26.771/7.039 ms" outputStructuredPing: destinationIp: 8.8.8.8 destinationName: 8.8.8.8 dataBytes: 100 packetsTransmitted: 4 packetsReceived: 4 packetsLossPercent: 0 rttMin: 9.271 rttAvg: 15.483 rttMax: 26.771 rttStdDev: 7.039 responses: - bytes: 100 ip: 8.8.8.8 icmpSeq: 0 ttl: 117 time: 9.839 - bytes: 100 ip: 8.8.8.8 icmpSeq: 1 ttl: 117 time: 16.051 - bytes: 100 ip: 8.8.8.8 icmpSeq: 2 ttl: 117 time: 9.271 - bytes: 100 ip: 8.8.8.8 icmpSeq: 3 ttl: 117 time: 26.771 changeLog: createdBy: testuser createdDateTime: 2020-05-21T10:30:00Z 400_invalid_state_commands: value: - errorCode: EQ-3043023 errorMessage: Cannot delete Command in pending state correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Cannot delete Fabric Cloud Router in transient state. SearchFilterByNextHop: value: filter: and: - property: /nextHop operator: = values: - 67.2223.179.193 pagination: offset: 0 limit: 20 sort: - direction: DESC property: /changeLog/createdDateTime SearchFilterByPrefix: value: filter: and: - property: /prefix operator: = values: - 10.203.1.0/30 pagination: offset: 0 limit: 20 sort: - direction: DESC property: /changeLog/createdDateTime SearchFilterByType: value: filter: and: - property: /type operator: = values: - IPv4_BGP_ROUTE pagination: offset: 0 limit: 20 sort: - direction: DESC property: /changeLog/createdDateTime SearchFilterByStatus: value: filter: and: - property: /state operator: = values: - ACTIVE pagination: offset: 0 limit: 20 sort: - direction: DESC property: /changeLog/createdDateTime SearchFilterOrAnd: value: filter: and: - or: - property: /type operator: LIKE values: - IPv4_BGP_ROUTE - property: /type operator: LIKE values: - abc Request-direct-ipv4: value: filter: and: - property: /directIpv4/equinixIfaceIp operator: = values: - 10.1.1.1/30 - property: /connection/uuid operator: = values: - a96f16d3-e504-44a7-a628-4916b5750008 Request-direct-ipv6: value: filter: and: - property: /directIpv6/equinixIfaceIp operator: = values: - 1202:ABCD::20:1::11/30 - property: /connection/uuid operator: = values: - a96f16d3-e504-44a7-a628-4916b5750008 Response-200: value: additionalInfo: - key: message value: The provided subnet is valid. error-400: value: - errorCode: EQ-2041022 errorMessage: Invalid argument value passed. correlationId: 5f9f9ab9-a6cb-4e8a-aa34-105cd4cb6cc8 error-400-overlappingSubnet: value: - errorCode: EQ-2041022 errorMessage: The provided subnet is not valid. details: The provided subnet is overlapping with other connections in the same Fabric Cloud Router. correlationId: 5f9f9ab9-a6cb-4e8a-aa34-105cd4cb6cc8 SearchFilterByNameAndMetroName: value: filter: and: - property: /name operator: = values: - test-fg - property: /metroName operator: LIKE values: - Si% - property: /project/projectId operator: = values: - "995072000433550" pagination: offset: 0 limit: 20 sort: - direction: DESC property: /changeLog/createdDateTime search-example: value: pagination: offset: 20 limit: 20 total: 100 next: /search?offset=40&limit=20 previous: /search?offset=0&limit=20 data: - href: https://api.equinix.com/fabric/v4/routers/201b7346-a9eb-42fe-ae7a-08148c71928d uuid: 201b7346-a9eb-42fe-ae7a-08148c71928d state: PROVISIONED type: XF_ROUTER name: My-Cloud-Router location: metroHref: https://api.equinix.com/fabric/v4/metros/HH metroCode: HH equinixAsn: 30000 package: href: https://api.equinix.com/fabric/v4/routerPackages/STANDARD code: STANDARD order: purchaseOrderNumber: 1-129105284100 project: projectId: "123456" notifications: - type: ALL emails: - abc@abc.com account: accountNumber: 123 connectionsCount: 0 changeLog: createdBy: abc@xyz.com createdByFullName: abc createdByEmail: abc@xyz.com createdDateTime: 2021-09-24T06:59:46Z updatedBy: abc@xyz.com updatedByFullName: abc updatedByEmail: abc@xyz.com updatedDateTime: 2021-09-24T06:59:46Z deletedBy: abc@xyz.com deletedByFullName: abc deletedByEmail: abc@xyz.com deletedDateTime: 2021-09-24T06:59:46Z ListFCRPackagesResponse: value: pagination: offset: 0 limit: 20 total: 4 data: - href: https://api.equinix.com/fabric/v4/routerPackages/LAB type: ROUTER_PACKAGE code: LAB description: string totalIPv4RoutesMax: 50 totalIPv6RoutesMax: 50 routeFilterSupported: true vcCountMax: 10 crCountMax: 3 vcBandwidthMax: 50 changeLog: createdDateTime: 2022-02-10T00:14:47Z updatedDateTime: 2022-02-10T00:14:47Z - href: https://api.equinix.com/fabric/v4/routerPackages/STANDARD type: ROUTER_PACKAGE code: STANDARD description: string totalIPv4RoutesMax: 1000 totalIPv6RoutesMax: 100 routeFilterSupported: true vcCountMax: 10 crCountMax: 3 vcBandwidthMax: 10000 changeLog: createdDateTime: 2023-02-10T00:14:47Z updatedDateTime: 2023-02-10T00:14:47Z - href: https://api.equinix.com/fabric/v4/routerPackages/ADVANCED type: ROUTER_PACKAGE code: ADVANCED description: string totalIPv4RoutesMax: 4000 totalIPv6RoutesMax: 250 routeFilterSupported: true vcCountMax: 99999 crCountMax: 3 vcBandwidthMax: 50000 changeLog: createdDateTime: 2023-02-10T00:14:47Z updatedDateTime: 2023-02-10T00:14:47Z - href: https://api.equinix.com/fabric/v4/routerPackages/PREMIUM type: ROUTER_PACKAGE code: PREMIUM description: string totalIPv4RoutesMax: 10000 totalIPv6RoutesMax: 500 routeFilterSupported: true vcCountMax: 10 crCountMax: 3 vcBandwidthMax: 50000 changeLog: createdDateTime: 2023-02-10T00:14:47Z updatedDateTime: 2023-02-10T00:14:47Z healthResponse: value: href: null version: "4.4" release: 2022.4.0 description: Equinix Fabric Health Check API state: HEALTHY apiServices: - route: /prices status: UP changedDateTime: 2022-10-03T18:37:54.760+00:00 - route: /connections status: UP changedDateTime: 2022-10-03T18:37:56.818+00:00 - route: /ports status: UP changedDateTime: 2022-10-03T18:37:56.886+00:00 - route: /serviceTokens status: UP changedDateTime: 2022-10-03T18:37:56.919+00:00 - route: /stats status: UP changedDateTime: 2022-10-03T18:37:56.951+00:00 - route: /routers status: UP changedDateTime: 2022-10-03T18:37:57.271+00:00 - route: /serviceProfiles status: UP changedDateTime: 2022-10-03T18:38:01.298+00:00 Request_Alibaba: value: filter: and: - property: /zSide/accessPoint/authenticationKey operator: = values: - xxx-xxx-xxx - property: /zSide/accessPoint/profile/uuid operator: = values: - xxx-xxx-xxx - property: /zSide/accessPoint/sellerRegion operator: = values: - San Jose 2 Request_AWS: value: filter: and: - property: /zSide/accessPoint/authenticationKey operator: = values: - xxx-xxx-xxx - property: /zSide/accessPoint/profile/uuid operator: = values: - xxx-xxx-xxx - property: /zSide/accessPoint/sellerRegion operator: = values: - us-west-1 Request_Azure: value: filter: and: - property: /zSide/accessPoint/authenticationKey operator: = values: - xxx-xxx-xxx - property: /zSide/accessPoint/profile/uuid operator: = values: - xxx-xxx-xxx Request_Google: value: filter: and: - property: /zSide/accessPoint/authenticationKey operator: = values: - xxx-xxx-xxx/xxx/x - property: /zSide/accessPoint/profile/uuid operator: = values: - xxx-xxx-xxx - property: /zSide/accessPoint/sellerRegion operator: = values: - us-west-1 Request_IBM_1: value: filter: and: - property: /zSide/accessPoint/authenticationKey operator: = values: - xxx-xxx-xxx - property: /zSide/accessPoint/profile/uuid operator: = values: - xxx-xxx-xxx - property: /zSide/accessPoint/sellerRegion operator: = values: - San Jose 2 Request_IBM_2: value: filter: and: - property: /zSide/accessPoint/authenticationKey operator: = values: - xxx-xxx-xxx - property: /zSide/accessPoint/profile/uuid operator: = values: - xxx-xxx-xxx - property: /zSide/accessPoint/sellerRegion operator: = values: - San Jose 2 Request_Oracle: value: filter: and: - property: /zSide/accessPoint/authenticationKey operator: = values: - xxx-xxx-xxx - property: /zSide/accessPoint/profile/uuid operator: = values: - xxx-xxx-xxx - property: /zSide/accessPoint/sellerRegion operator: = values: - us-ashburn-1 Dot1q_Vlan: value: filter: and: - property: /zSide/accessPoint/port/uuid operator: = values: - 77b1b527-1a0f-42eb-9173-6d91723556b8 - property: /zSide/accessPoint/linkProtocol/vlanTag operator: = values: - "155" Qinq_Vlan: value: filter: and: - property: /zSide/accessPoint/port/uuid operator: = values: - 77b1b527-1a0f-42eb-9173-6d91723556b8 - property: /zSide/accessPoint/linkProtocol/vlanSTag operator: = values: - "155" - property: /zSide/accessPoint/linkProtocol/vlanCTag operator: = values: - "156" Response-Alibaba: value: additionalInfo: - key: message value: Authorization key provided is valid Response-Aws: value: additionalInfo: - key: message value: Authorization key provided is valid Response-Azure-no-existing-connections: value: additionalInfo: - key: message value: Authorization key provided is valid data: - bandwidth: 50 redundancy: priority: PRIMARY zSide: accessPoint: type: COLO port: type: XF_PORT name: Port-Name-1 location: metroCode: SV peeringType: PRIVATE linkProtocol: type: QINQ vlanSTag: 1003 - bandwidth: 50 redundancy: priority: SECONDARY zSide: accessPoint: type: COLO port: type: XF_PORT name: Port-Name-2 location: metroCode: SV peeringType: PRIVATE linkProtocol: type: QINQ vlanSTag: 1003 - bandwidth: 50 redundancy: priority: PRIMARY zSide: accessPoint: type: COLO port: type: XF_PORT name: Port-Name-3 location: metroCode: SV peeringType: MICROSOFT linkProtocol: type: QINQ vlanSTag: 1003 - bandwidth: 50 redundancy: priority: SECONDARY zSide: accessPoint: type: COLO port: type: XF_PORT name: Port-Name-4 location: metroCode: SV peeringType: MICROSOFT linkProtocol: type: QINQ vlanSTag: 1003 Response-Azure-1-existing-Dot1q-connection: value: additionalInfo: - key: message value: Authorization key provided is valid data: - bandwidth: 50 redundancy: priority: PRIMARY aside: accessPoint: type: COLO linkProtocol: type: DOT1Q zSide: accessPoint: type: COLO port: type: XF_PORT name: Port-Name-1 location: metroCode: SV peeringType: PRIVATE linkProtocol: type: QINQ vlanSTag: 1003 - bandwidth: 50 redundancy: priority: SECONDARY aside: accessPoint: type: COLO linkProtocol: type: DOT1Q zSide: accessPoint: type: COLO port: type: XF_PORT name: Port-Name-2 location: metroCode: SV peeringType: PRIVATE linkProtocol: type: QINQ vlanSTag: 1003 - bandwidth: 50 redundancy: priority: SECONDARY aside: accessPoint: type: COLO linkProtocol: type: DOT1Q zSide: accessPoint: type: COLO port: type: XF_PORT name: Port-Name-3 location: metroCode: SV peeringType: MICROSOFT linkProtocol: type: QINQ vlanSTag: 1003 Response-Azure-1-existing-Qinq-connection: value: additionalInfo: - key: message value: Authorization key provided is valid data: - bandwidth: 500 redundancy: priority: PRIMARY aside: accessPoint: type: VD linkProtocol: type: QINQ zSide: accessPoint: type: COLO port: type: XF_PORT name: Port-Name-1 location: metroCode: SV linkProtocol: type: QINQ vlanSTag: 1003 Response-Azure-2-existing-Dot1q-connections: value: additionalInfo: - key: message value: Authorization key provided is valid data: - bandwidth: 50 redundancy: priority: SECONDARY aside: accessPoint: type: CLOUD_ROUTER zSide: accessPoint: type: COLO port: type: XF_PORT name: Port-Name-2 location: metroCode: SV peeringType: MICROSOFT linkProtocol: type: QINQ vlanSTag: 1003 - bandwidth: 50 redundancy: priority: SECONDARY aside: accessPoint: type: CLOUD_ROUTER zSide: accessPoint: type: COLO port: type: XF_PORT name: Port-Name-3 location: metroCode: SV peeringType: MICROSOFT linkProtocol: type: QINQ vlanSTag: 1003 Response-Google: value: additionalInfo: - key: message value: Authorization key provided is valid Response-IBM-1: value: additionalInfo: - key: message value: Authorization key provided is valid Response-IBM-2: value: additionalInfo: - key: message value: Authorization key provided is valid Response-Oracle: value: additionalInfo: - key: message value: Authorization key provided is valid data: - bandwidth: 1000 Response-Dot1q-Vlan: value: additionalInfo: - key: message value: vlanTag(s) provided is available Response-Qinq-Vlan: value: additionalInfo: - key: message value: vlanTag(s) provided is available ConnectionEvent: value: pagination: offset: 20 limit: 10 total: 2 next: null previous: null data: - href: https://api.equinix.com/fabric/v4/events/4362dbd4-0118-445c-9542-82a35a1a4c70 type: TRANSACTION_STATUS_AUDIT uuid: 4362dbd4-0118-445c-9542-82a35a1a4c70 createdDateTime: 2022-02-03 15:06:09.16835 additionalInfo: - key: correlationId value: testSp connection: href: https://api.equinix.com/fabric/v4/connections/f372169c-3e19-413a-849f-7ecc7fc536d7 type: EVPL_VC uuid: f372169c-3e19-413a-849f-7ecc7fc536d7 name: test_connection transaction: type: ASSET_CREATION state: INITIATED initatedDateTime: 2022-02-03 15:06:09.16835 duration: PT0S durationSlo: PT2M20S stage: external: true type: CONNECTION_REQUEST_VALIDATOR state: INITIATED initiatedDateTime: 2022-02-03 15:06:09.16835 completedDateTime: 2022-02-03 15:06:09.16845 duration: PT10S durationSlo: PT0S - href: https://api.equinix.com/fabric/v4/events/4362dbd4-0118-445c-9542-82a35a1a4c70 type: TRANSACTION_STATUS_AUDIT uuid: 4362dbd4-0118-445c-9542-82a35a1a4c70 createdDateTime: 2022-02-03 15:06:09.16835 additionalInfo: - key: correlationId value: testSp connection: href: https://api.equinix.com/fabric/v4/connections/f372169c-3e19-413a-849f-7ecc7fc536d7 type: EVPL_VC uuid: f372169c-3e19-413a-849f-7ecc7fc536d7 name: test_connection transaction: type: ASSET_CREATION state: FAILED initatedDateTime: 2022-02-03 15:06:09.16835 duration: PT0S durationSlo: PT2M20S stage: external: true type: CONNECTION_REQUEST_VALIDATOR state: FAILED initiatedDateTime: 2022-02-03 15:06:09.16835 completedDateTime: 2022-02-03 15:06:09.16845 duration: PT10S durationSlo: PT0S errors: - errorCode: EQ-3142532 errorMessage: Token with Invalid Status to create connection, Please enter valid ServiceToken details: Please enter valid ServiceToken UUID. RoutingProtocolOperationStatusEvent: value: pagination: offset: 10 limit: 10 total: 100 data: - createdDateTime: 2023-04-01T10:30:00Z href: https://api.equinix.com/fabric/v4/events/422504a4-286d-44e7-b386-8e385d2e99e1 uuid: 422504a4-286d-44e7-b386-8e385d2e99e1 type: RP_OPSTATUS_NOTIFICATION subType: BGP_IPV4_STATE_CHANGE severity: 5 message: Neighbor 64.233.197.44 address session state changed to Established routingProtocol: href: https://api.equinix.com/fabric/v4/connections/ecd30480-07a1-469e-ad38-65fadf0f7221/routingProtocols/b3fb4f30-3f5c-4aa7-a003-b2973c9d81e4 type: BGP uuid: b3fb4f30-3f5c-4aa7-a003-b2973c9d81e4 connection: href: https://api.equinix.com/fabric/v4/connections/ecd30480-07a1-469e-ad38-65fadf0f7221 type: IP_VC uuid: ecd30480-07a1-469e-ad38-65fadf0f7221 router: href: https://api.equinix.com/fabric/v4/routers/e2e99d48-66b8-4b80-84eb-daea190e9186 type: XF_ROUTER uuid: e2e99d48-66b8-4b80-84eb-daea190e9186 - createdDateTime: 2023-04-01T10:29:00Z href: https://api.equinix.com/fabric/v4/events/422504a4-286d-44e7-b386-8e385d2e99e2 uuid: 422504a4-286d-44e7-b386-8e385d2e99e2 type: RP_OPSTATUS_NOTIFICATION subType: BGP_IPV4_ADMIN_ENABLE severity: 6 message: Neighbor 64.233.197.44 Administrative Enable successful routingProtocol: href: https://api.equinix.com/fabric/v4/connections/ecd30480-07a1-469e-ad38-65fadf0f7221/routingProtocols/b3fb4f30-3f5c-4aa7-a003-b2973c9d81e4 type: BGP uuid: b3fb4f30-3f5c-4aa7-a003-b2973c9d81e4 connection: href: https://api.equinix.com/fabric/v4/connections/ecd30480-07a1-469e-ad38-65fadf0f7221 type: IP_VC uuid: ecd30480-07a1-469e-ad38-65fadf0f7221 router: href: https://api.equinix.com/fabric/v4/routers/e2e99d48-66b8-4b80-84eb-daea190e9186 type: XF_ROUTER uuid: e2e99d48-66b8-4b80-84eb-daea190e9186 - createdDateTime: 2023-04-01T10:28:00Z href: https://api.equinix.com/fabric/v4/events/422504a4-286d-44e7-b386-8e385d2e99e3 uuid: 422504a4-286d-44e7-b386-8e385d2e99e3 type: RP_OPSTATUS_NOTIFICATION subType: BGP_IPV4_NEIGHBOR_RESET severity: 6 message: Neighbor 64.233.197.44 Administrative Reset successful routingProtocol: href: https://api.equinix.com/fabric/v4/connections/ecd30480-07a1-469e-ad38-65fadf0f7221/routingProtocols/b3fb4f30-3f5c-4aa7-a003-b2973c9d81e4 type: BGP uuid: b3fb4f30-3f5c-4aa7-a003-b2973c9d81e4 connection: href: https://api.equinix.com/fabric/v4/connections/ecd30480-07a1-469e-ad38-65fadf0f7221 type: IP_VC uuid: ecd30480-07a1-469e-ad38-65fadf0f7221 router: href: https://api.equinix.com/fabric/v4/routers/e2e99d48-66b8-4b80-84eb-daea190e9186 type: XF_ROUTER uuid: e2e99d48-66b8-4b80-84eb-daea190e9186 - createdDateTime: 2023-04-01T10:27:00Z href: https://api.equinix.com/fabric/v4/events/422504a4-286d-44e7-b386-8e385d2e99e4 uuid: 422504a4-286d-44e7-b386-8e385d2e99e4 type: RP_CONFIG_NOTIFICATION subType: BGP_IPV4_CONFIG severity: 6 message: Neighbor 64.233.197.44 configuration successful routingProtocol: href: https://api.equinix.com/fabric/v4/connections/ecd30480-07a1-469e-ad38-65fadf0f7221/routingProtocols/b3fb4f30-3f5c-4aa7-a003-b2973c9d81e4 type: BGP uuid: b3fb4f30-3f5c-4aa7-a003-b2973c9d81e4 connection: href: https://api.equinix.com/fabric/v4/connections/ecd30480-07a1-469e-ad38-65fadf0f7221 type: IP_VC uuid: ecd30480-07a1-469e-ad38-65fadf0f7221 router: href: https://api.equinix.com/fabric/v4/routers/e2e99d48-66b8-4b80-84eb-daea190e9186 type: XF_ROUTER uuid: e2e99d48-66b8-4b80-84eb-daea190e9186 RoutesQuotaEvent: value: pagination: offset: 10 limit: 10 total: 100 data: - createdDateTime: 2023-04-01T10:30:00Z href: https://api.equinix.com/fabric/v4/events/422504a4-286d-44e7-b386-8e385d2e99e1 uuid: 422504a4-286d-44e7-b386-8e385d2e99e1 type: RP_CONFIG_NOTIFICATION subType: CLOUD_ROUTER_IPV4_ROUTE_USAGE_REACHED_LIMIT severity: 2 message: The Fabric Cloud Router my-fcr-1, UUID :422504a4-286d-44e7-b386-8e385d2e99e1 has reached 100% of the IPv4 maximum routes quota. Avoid a network impact by upgrading the Fabric Cloud Router package. router: href: https://api.equinix.com/fabric/v4/routers/e2e99d48-66b8-4b80-84eb-daea190e9186 type: XF_ROUTER uuid: e2e99d48-66b8-4b80-84eb-daea190e9186 - createdDateTime: 2023-04-01T10:30:00Z href: https://api.equinix.com/fabric/v4/events/422504a4-286d-44e7-b386-8e385d2e99e1 uuid: 422504a4-286d-44e7-b386-8e385d2e99e1 type: RP_CONFIG_NOTIFICATION subType: CLOUD_ROUTER_IPV4_ROUTE_USAGE_REACHED_THRESHOLD severity: 4 message: The Fabric Cloud Router my-fcr-1, UUID :422504a4-286d-44e7-b386-8e385d2e99e1 has reached 90% of the IPv4 maximum routes quota. Avoid a network impact by upgrading the Fabric Cloud Router package. router: href: https://api.equinix.com/fabric/v4/routers/e2e99d48-66b8-4b80-84eb-daea190e9186 type: XF_ROUTER uuid: e2e99d48-66b8-4b80-84eb-daea190e9186 Create-Global-EVPLAN-Network: value: type: EVPLAN name: My-Network-1 scope: GLOBAL project: projectId: d64fa54a-cfcb-4fb0-82ee-86cf47007fa2 notifications: - type: ALL emails: - test@equinix.com Create-Regional-EVPLAN-Network: value: type: EVPLAN name: My-Network-1 scope: REGIONAL location: region: EMEA project: projectId: d64fa54a-cfcb-4fb0-82ee-86cf47007fa2 notifications: - type: ALL emails: - test@equinix.com Create-Local-EVPLAN-Network: value: type: EVPLAN name: My-Network-1 scope: LOCAL project: projectId: d64fa54a-cfcb-4fb0-82ee-86cf47007fa2 notifications: - type: ALL emails: - test@equinix.com Create-Global-EPLAN-Network: value: type: EPLAN name: My-EPLAN-Network-1 scope: GLOBAL project: projectId: d64fa54a-cfcb-4fb0-82ee-86cf47007fa2 notifications: - type: ALL emails: - test@equinix.com Create-Regional-EPLAN-Network: value: type: EPLAN name: My-EPLAN-Network-1 scope: REGIONAL location: region: EMEA project: projectId: d64fa54a-cfcb-4fb0-82ee-86cf47007fa2 notifications: - type: ALL emails: - test@equinix.com Create-Local-EPLAN-Network: value: type: EPLAN name: My-EPLAN-Network-1 scope: LOCAL project: projectId: d64fa54a-cfcb-4fb0-82ee-86cf47007fa2 notifications: - type: ALL emails: - test@equinix.com Create-Global-EVPTREE-Network: value: type: EVPTREE name: My-EVPTREE-Network-1 scope: GLOBAL project: projectId: d64fa54a-cfcb-4fb0-82ee-86cf47007fa2 notifications: - type: ALL emails: - test@equinix.com Create-Regional-EVPTREE-Network: value: type: EVPTREE name: My-EVPTREE-Network-1 scope: REGIONAL location: region: AMER project: projectId: d64fa54a-cfcb-4fb0-82ee-86cf47007fa2 notifications: - type: ALL emails: - test@equinix.com Create-Local-EVPTREE-Network: value: type: EVPTREE name: My-EVPTREE-Network-1 scope: LOCAL project: projectId: d64fa54a-cfcb-4fb0-82ee-86cf47007fa2 notifications: - type: ALL emails: - test@equinix.com Create-Global-EPTREE-Network: value: type: EPTREE name: My-EPTREE-Network-1 scope: GLOBAL project: projectId: d64fa54a-cfcb-4fb0-82ee-86cf47007fa2 notifications: - type: ALL emails: - test@equinix.com Create-Regional-EPTREE-Network: value: type: EPTREE name: My-EPTREE-Network-1 scope: REGIONAL location: region: AMER project: projectId: d64fa54a-cfcb-4fb0-82ee-86cf47007fa2 notifications: - type: ALL emails: - test@equinix.com Create-Local-EPTREE-Network: value: type: EPTREE name: My-EPTREE-Network-1 scope: LOCAL project: projectId: d64fa54a-cfcb-4fb0-82ee-86cf47007fa2 notifications: - type: ALL emails: - test@equinix.com CreateNetworkDryRunResponse: value: type: EVPLAN name: My-EVPLAN-1 scope: GLOBAL project: projectId: z1a596ed-s24a-097c-12a8-44e00000ee11 notifications: - type: ALL emails: - test@equinix.com Create-Global-EVPLAN-Network-Response: value: href: https://api.corp.equinix.com/fabric/v4/networks/0633e83f-116f-481d-b86f-c472271d1a8c uuid: 0633e83f-116f-481d-b86f-c472271d1a8c type: EVPLAN name: My-evplan-network-1 scope: GLOBAL state: INACTIVE connectionsCount: 0 account: orgId: 14510 organizationName: fabric globalCustId: 0026u00000595sBAAM change: href: https://api.corp.equinix.com/fabric/v4/networks/0633e83f-116f-481d-b86f-c472271d1a8c/changes/ce7c0bbc-7bd2-431f-903f-de796ea9e858 uuid: ce7c0bbc-7bd2-431f-903f-de796ea9e858 type: NETWORK_CREATION operation: equinixStatus: PROVISIONING changeLog: createdBy: fabric createdByFullName: fabric fabric createdByEmail: fabric@gmail.com createdDateTime: 2025-03-03T19:37:29.326Z links: href: https://api.corp.equinix.com/fabric/v4/networks/0633e83f-116f-481d-b86f-c472271d1a8c/connections rel: getConnectionsByNetworkUuid method: GET contentType: application/json authenticate: true project: projectId: d64fa54a-cfcb-4fb0-82ee-86cf47007fa2 notifications: - type: ALL emails: - fabric@gmail.com Create-Regional-EVPLAN-Network-Response: value: href: https://api.corp.equinix.com/fabric/v4/networks/884254b7-237d-44f7-af0f-84ba324350ef uuid: 884254b7-237d-44f7-af0f-84ba324350ef type: EVPLAN name: My-evplan-network-1 scope: REGIONAL location: region: AMER state: INACTIVE connectionsCount: 0 account: orgId: 14510 organizationName: fabric globalCustId: 0026u00000595sBAAM change: href: https://api.corp.equinix.com/fabric/v4/networks/884254b7-237d-44f7-af0f-84ba324350ef/changes/741c0927-d9ed-405b-a4f2-cb61d0dda2c5 uuid: 741c0927-d9ed-405b-a4f2-cb61d0dda2c5 type: NETWORK_CREATION operation: equinixStatus: PROVISIONING changeLog: createdBy: fabric createdByFullName: fabric fabric createdByEmail: fabric@gmail.com createdDateTime: 2025-03-03T19:21:43.145Z links: href: https://api.corp.equinix.com/fabric/v4/networks/884254b7-237d-44f7-af0f-84ba324350ef/connections rel: getConnectionsByNetworkUuid method: GET contentType: application/json authenticate: true project: projectId: d64fa54a-cfcb-4fb0-82ee-86cf47007fa2 notifications: - type: ALL emails: - fabric@gmail.com Create-Local-EVPLAN-Network-Response: value: href: https://api.corp.equinix.com/fabric/v4/networks/726af704-0b1b-46dc-9efc-00fc938084b3 uuid: 726af704-0b1b-46dc-9efc-00fc938084b3 type: EVPLAN name: My-evplan-network-1 scope: LOCAL state: INACTIVE connectionsCount: 0 account: orgId: 14510 organizationName: fabric globalCustId: 0026u00000595sBAAM change: href: https://api.corp.equinix.com/fabric/v4/networks/726af704-0b1b-46dc-9efc-00fc938084b3/changes/92e2f236-e77d-4818-bbad-cff6b716a610 uuid: 92e2f236-e77d-4818-bbad-cff6b716a610 type: NETWORK_CREATION operation: equinixStatus: PROVISIONING changeLog: createdBy: fabric createdByFullName: fabric fabric createdByEmail: fabric@gmail.com createdDateTime: 2025-03-03T19:43:20.145Z links: href: https://api.corp.equinix.com/fabric/v4/networks/726af704-0b1b-46dc-9efc-00fc938084b3/connections rel: getConnectionsByNetworkUuid method: GET contentType: application/json authenticate: true project: projectId: d64fa54a-cfcb-4fb0-82ee-86cf47007fa2 notifications: - type: ALL emails: - fabric@gmail.com Create-Global-EPLAN-Network-Response: value: href: https://api.corp.equinix.com/fabric/v4/networks/0d51722e-b080-4943-92ab-9720eaab2cfa uuid: 0d51722e-b080-4943-92ab-9720eaab2cfa type: EPLAN name: My-eplan-network-1 scope: GLOBAL state: INACTIVE connectionsCount: 0 account: orgId: 14510 organizationName: fabric globalCustId: 0026u00000595sBAAM change: href: https://api.corp.equinix.com/fabric/v4/networks/0d51722e-b080-4943-92ab-9720eaab2cfa/changes/e4f9c57f-a1d6-4520-9a31-fddbe69ed592 uuid: e4f9c57f-a1d6-4520-9a31-fddbe69ed592 type: NETWORK_CREATION operation: equinixStatus: PROVISIONING changeLog: createdBy: fabric createdByFullName: fabric fabric createdByEmail: fabric@gmail.com createdDateTime: 2025-03-03T20:52:23.469Z links: href: https://api.corp.equinix.com/fabric/v4/networks/0d51722e-b080-4943-92ab-9720eaab2cfa/connections rel: getConnectionsByNetworkUuid method: GET contentType: application/json authenticate: true project: projectId: d64fa54a-cfcb-4fb0-82ee-86cf47007fa2 notifications: - type: ALL emails: - fabric@gmail.com Create-Regional-EPLAN-Network-Response: value: href: https://api.corp.equinix.com/fabric/v4/networks/884254b7-237d-44f7-af0f-84ba324350ef uuid: 884254b7-237d-44f7-af0f-84ba324350ef type: EVPLAN name: My-evplan-network-1 scope: REGIONAL location: region: AMER state: INACTIVE connectionsCount: 0 account: orgId: 14510 organizationName: fabric globalCustId: 0026u00000595sBAAM change: href: https://api.corp.equinix.com/fabric/v4/networks/884254b7-237d-44f7-af0f-84ba324350ef/changes/741c0927-d9ed-405b-a4f2-cb61d0dda2c5 uuid: 741c0927-d9ed-405b-a4f2-cb61d0dda2c5 type: NETWORK_CREATION operation: equinixStatus: PROVISIONING changeLog: createdBy: fabric createdByFullName: fabric fabric createdByEmail: fabric@gmail.com createdDateTime: 2025-03-03T19:21:43.145Z links: href: https://api.corp.equinix.com/fabric/v4/networks/884254b7-237d-44f7-af0f-84ba324350ef/connections rel: getConnectionsByNetworkUuid method: GET contentType: application/json authenticate: true project: projectId: d64fa54a-cfcb-4fb0-82ee-86cf47007fa2 notifications: - type: ALL emails: - fabric@gmail.com Create-Local-EPLAN-Network-Response: value: href: https://api.corp.equinix.com/fabric/v4/networks/82402fc0-cb55-4a21-b0b3-1af89f63742b uuid: 82402fc0-cb55-4a21-b0b3-1af89f63742b type: EPLAN name: My-eplan-network-1 scope: LOCAL state: INACTIVE connectionsCount: 0 account: orgId: 14510 organizationName: fabric globalCustId: 0026u00000595sBAAM change: href: https://api.corp.equinix.com/fabric/v4/networks/82402fc0-cb55-4a21-b0b3-1af89f63742b/changes/1449105b-7576-4094-aa34-216f3f9ed122 uuid: 1449105b-7576-4094-aa34-216f3f9ed122 type: NETWORK_CREATION operation: equinixStatus: PROVISIONING changeLog: createdBy: fabric createdByFullName: fabric fabric createdByEmail: fabric@gmail.com createdDateTime: 2025-03-03T20:55:57.858Z links: href: https://api.corp.equinix.com/fabric/v4/networks/82402fc0-cb55-4a21-b0b3-1af89f63742b/connections rel: getConnectionsByNetworkUuid method: GET contentType: application/json authenticate: true project: projectId: d64fa54a-cfcb-4fb0-82ee-86cf47007fa2 notifications: - type: ALL emails: - fabric@gmail.com Create-Global-EVPTREE-Network-Response: value: href: https://api.corp.equinix.com/fabric/v4/networks/07659346-9489-42cf-891a-683624e801d5 uuid: 07659346-9489-42cf-891a-683624e801d5 type: EVPTREE name: My-evptree-network-1 scope: GLOBAL state: INACTIVE connectionsCount: 0 account: orgId: 14510 organizationName: fabric globalCustId: 0026u00000595sBAAM change: href: https://api.corp.equinix.com/fabric/v4/networks/07659346-9489-42cf-891a-683624e801d5/changes/1caf3efb-7427-4be1-8100-73fcff471654 uuid: 1caf3efb-7427-4be1-8100-73fcff471654 type: NETWORK_CREATION operation: equinixStatus: PROVISIONING changeLog: createdBy: fabric createdByFullName: fabric fabric createdByEmail: fabric@equinix.comm createdDateTime: 2025-03-05T21:17:46.656Z links: href: https://api.corp.equinix.com/fabric/v4/networks/07659346-9489-42cf-891a-683624e801d5/connections rel: getConnectionsByNetworkUuid method: GET contentType: application/json authenticate: true project: projectId: d64fa54a-cfcb-4fb0-82ee-86cf47007fa2 notifications: - type: ALL emails: - fabric@equinix.com Create-Regional-EVPTREE-Network-Response: value: href: https://api.corp.equinix.com/fabric/v4/networks/0ec08139-bae5-44c4-bea2-970b14d7c7c0 uuid: 0ec08139-bae5-44c4-bea2-970b14d7c7c0 type: EVPTREE name: My-evptree-network-1 scope: REGIONAL location: region: AMER state: INACTIVE connectionsCount: 0 account: orgId: 14510 organizationName: fabric globalCustId: 0026u00000595sBAAM change: href: https://api.corp.equinix.com/fabric/v4/networks/0ec08139-bae5-44c4-bea2-970b14d7c7c0/changes/0e159ddd-47d2-4fa3-97fe-502f8a70ea0e uuid: 0e159ddd-47d2-4fa3-97fe-502f8a70ea0e type: NETWORK_CREATION operation: equinixStatus: PROVISIONING changeLog: createdBy: fabric createdByFullName: fabric fabric createdByEmail: fabric@equinix.com createdDateTime: 2025-03-05T20:57:07.206Z links: href: https://api.corp.equinix.com/fabric/v4/networks/0ec08139-bae5-44c4-bea2-970b14d7c7c0/connections rel: getConnectionsByNetworkUuid method: GET contentType: application/json authenticate: true project: projectId: d64fa54a-cfcb-4fb0-82ee-86cf47007fa2 notifications: - type: ALL emails: - fabric@equinix.com Create-Local-EVPTREE-Network-Response: value: href: https://api.corp.equinix.com/fabric/v4/networks/4622cce8-114b-4432-94f4-060fda044ae3 uuid: 4622cce8-114b-4432-94f4-060fda044ae3 type: EVPTREE name: My-evptree-network-1 scope: LOCAL state: INACTIVE connectionsCount: 0 account: orgId: 14510 organizationName: fabric globalCustId: 0026u00000595sBAAM change: href: https://api.corp.equinix.com/fabric/v4/networks/4622cce8-114b-4432-94f4-060fda044ae3/changes/6eacff89-a363-402f-ae15-84294177a866 uuid: 6eacff89-a363-402f-ae15-84294177a866 type: NETWORK_CREATION operation: equinixStatus: PROVISIONING changeLog: createdBy: fabric createdByFullName: fabric fabric createdByEmail: fabric@equinix.com createdDateTime: 2025-03-05T21:22:30.984Z links: href: https://api.corp.equinix.com/fabric/v4/networks/4622cce8-114b-4432-94f4-060fda044ae3/connections rel: getConnectionsByNetworkUuid method: GET contentType: application/json authenticate: true project: projectId: d64fa54a-cfcb-4fb0-82ee-86cf47007fa2 notifications: - type: ALL emails: - fabric@equinix.com Create-Global-EPTREE-Network-Response: value: href: https://api.corp.equinix.com/fabric/v4/networks/16ee541c-9e93-428b-9557-3f99907aa21c uuid: 16ee541c-9e93-428b-9557-3f99907aa21c type: EPTREE name: My-eptree-network-1 scope: GLOBAL state: INACTIVE connectionsCount: 0 account: orgId: 14510 organizationName: fabric globalCustId: 0026u00000595sBAAM change: href: https://api.corp.equinix.com/fabric/v4/networks/16ee541c-9e93-428b-9557-3f99907aa21c/changes/2f541dcd-c25b-43a1-97fa-8b2be6817899 uuid: 2f541dcd-c25b-43a1-97fa-8b2be6817899 type: NETWORK_CREATION operation: equinixStatus: PROVISIONING changeLog: createdBy: fabric createdByFullName: fabric fabric createdByEmail: fabric@equinix.com createdDateTime: 2025-03-05T21:37:08.370Z links: href: https://api.corp.equinix.com/fabric/v4/networks/16ee541c-9e93-428b-9557-3f99907aa21c/connections rel: getConnectionsByNetworkUuid method: GET contentType: application/json authenticate: true project: projectId: d64fa54a-cfcb-4fb0-82ee-86cf47007fa2 notifications: - type: ALL emails: - fabric@equinix.com Create-Regional-EPTREE-Network-Response: value: href: https://api.corp.equinix.com/fabric/v4/networks/291fc758-91d3-482b-a9b3-3430685c390e uuid: 291fc758-91d3-482b-a9b3-3430685c390e type: EPTREE name: My-eptree-network-1 scope: REGIONAL location: region: EMEA state: INACTIVE connectionsCount: 0 account: orgId: 14510 organizationName: fabric globalCustId: 0026u00000595sBAAM change: href: https://api.corp.equinix.com/fabric/v4/networks/291fc758-91d3-482b-a9b3-3430685c390e/changes/8345324b-97cc-4c5c-9f15-40bc82b254ad uuid: 8345324b-97cc-4c5c-9f15-40bc82b254ad type: NETWORK_CREATION operation: equinixStatus: PROVISIONING changeLog: createdBy: fabric createdByFullName: fabric fabric createdByEmail: fabric@equinix.com createdDateTime: 2025-03-06T00:23:29.030Z links: href: https://api.corp.equinix.com/fabric/v4/networks/291fc758-91d3-482b-a9b3-3430685c390e/connections rel: getConnectionsByNetworkUuid method: GET contentType: application/json authenticate: true project: projectId: d64fa54a-cfcb-4fb0-82ee-86cf47007fa2 notifications: - type: ALL emails: - fabric@equinix.com Create-Local-EPTREE-Network-Response: value: href: https://api.corp.equinix.com/fabric/v4/networks/c929924e-5d87-46b2-a82f-91a145c1803d uuid: c929924e-5d87-46b2-a82f-91a145c1803d type: EPTREE name: My-eptree-network-1 scope: LOCAL state: INACTIVE connectionsCount: 0 account: orgId: 14510 organizationName: fabric globalCustId: 0026u00000595sBAAM change: href: https://api.corp.equinix.com/fabric/v4/networks/c929924e-5d87-46b2-a82f-91a145c1803d/changes/1b32bacb-5898-4efd-9404-b64ec825c652 uuid: 1b32bacb-5898-4efd-9404-b64ec825c652 type: NETWORK_CREATION operation: equinixStatus: PROVISIONING changeLog: createdBy: fabric createdByFullName: fabric fabric createdByEmail: fabric@equinix.com createdDateTime: 2025-03-06T00:30:42.972Z links: href: https://api.corp.equinix.com/fabric/v4/networks/c929924e-5d87-46b2-a82f-91a145c1803d/connections rel: getConnectionsByNetworkUuid method: GET contentType: application/json authenticate: true project: projectId: d64fa54a-cfcb-4fb0-82ee-86cf47007fa2 notifications: - type: ALL emails: - fabric@equinix.com NetworkPostResponseExample: value: href: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784 type: EVPLAN uuid: 92dc376a-a932-43aa-a6a2-c806dedbd784 name: My-EVPLAN-1 state: INACTIVE change: href: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784/changes/6d500177-9404-41f2-99e8-2bf1a84d8db5 uuid: 6d500177-9404-41f2-99e8-2bf1a84d8db5 type: NETWORK_CREATION location: region: EMEA scope: REGIONAL connectionsCount: 0 project: projectId: "123456" notifications: - type: ALL emails: - test@equinix.com operation: equinixStatus: PROVISIONING changeLog: createdBy: testuser createdDateTime: 2020-05-21T10:30:00Z createdByEmail: testuser@equinix.com createdByFullName: testuser testuser updatedBy: testuser updatedDateTime: 2020-05-21T10:30:00Z updatedByEmail: testuser@equinix.com updatedByFullName: testuser testuser NetworkGetResponseExample: value: href: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784 type: EVPLAN uuid: 92dc376a-a932-43aa-a6a2-c806dedbd784 name: My-EVPLAN-1 state: ACTIVE location: region: EMEA scope: REGIONAL connectionsCount: 0 project: projectId: "123456" notifications: - type: ALL emails: - test@equinix.com operation: equinixStatus: PROVISIONED changeLog: createdBy: testuser createdDateTime: 2020-05-21T10:30:00Z createdByEmail: testuser@equinix.com createdByFullName: testuser testuser updatedBy: testuser updatedDateTime: 2020-05-21T10:30:00Z updatedByEmail: testuser@equinix.com updatedByFullName: testuser testuser links: - href: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784/connections rel: getConnectionsByNetworkUuid method: GET contentType: application/json authenticate: true NetworkDeleteResponseExample: value: href: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784 type: EVPLAN uuid: 92dc376a-a932-43aa-a6a2-c806dedbd784 name: My-EVPLAN-1 state: INACTIVE change: href: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784/changes/6d500177-9404-41f2-99e8-2bf1a84d8db5 uuid: 6d500177-9404-41f2-99e8-2bf1a84d8db5 type: NETWORK_DELETION location: region: EMEA scope: REGIONAL project: projectId: "123456" notifications: - type: ALL emails: - test@equinix.com operation: equinixStatus: DEPROVISIONING changeLog: createdBy: testuser createdDateTime: 2020-05-21T10:30:00Z createdByEmail: testuser@equinix.com createdByFullName: testuser testuser updatedBy: testuser1 updatedDateTime: 2020-05-21T10:30:00Z updatedByEmail: testuser@equinix.com updatedByFullName: testuser testuser deletedBy: testuser1 deletedDateTime: 2020-05-21T10:30:00Z deletedByEmail: testuser@equinix.com deletedByFullName: testuser testuser UpdateNetworkName: value: - op: replace path: /name value: NewName UpdateNetworkNotifications: value: - op: replace path: /notifications value: - type: ALL emails: - test1@test.com - test2@test.com NetworkPatchResponseExample: value: href: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784 type: EVPLAN uuid: 92dc376a-a932-43aa-a6a2-c806dedbd784 name: My-EVPLAN-1 state: ACTIVE change: href: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784/changes/6d500177-9404-41f2-99e8-2bf1a84d8db5 uuid: 6d500177-9404-41f2-99e8-2bf1a84d8db5 type: NETWORK_UPDATE location: region: EMEA scope: REGIONAL connectionsCount: 0 project: projectId: "123456" notifications: - type: ALL emails: - test@equinix.com operation: equinixStatus: PROVISIONED changeLog: createdBy: testuser createdDateTime: 2020-05-21T10:30:00Z createdByEmail: testuser@equinix.com createdByFullName: testuser testuser updatedBy: testuser updatedDateTime: 2020-05-21T10:30:00Z updatedByEmail: testuser@equinix.com updatedByFullName: testuser testuser links: - href: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784/connections rel: getConnectionsByNetworkUuid method: GET contentType: application/json authenticate: true NetworkSearchResponseExample: value: pagination: offset: 0 limit: 20 total: 1 data: - href: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784 type: EVPLAN uuid: 92dc376a-a932-43aa-a6a2-c806dedbd784 platformUuid: 19dc376a-a932-43aa-a6a2-c806dedbd730 name: My-EVPLAN-1 state: ACTIVE location: region: EMEA scope: REGIONAL connectionsCount: 0 project: projectId: "567" notifications: - type: ALL emails: - test@equinix.com operation: equinixStatus: PROVISIONED changeLog: createdBy: testuser createdDateTime: 2020-05-21T10:30:00Z createdByEmail: testuser@equinix.com createdByFullName: testuser testuser updatedBy: testuser1 updatedDateTime: 2020-05-21T10:30:00Z updatedByEmail: testuser@equinix.com updatedByFullName: testuser testuser links: - href: https://api.equinix.com/fabric/v4/networks/92dc376a-a932-43aa-a6a2-c806dedbd784/connections rel: getConnectionsByNetworkUuid method: GET contentType: application/json authenticate: true sort: - property: /changeLog/updatedDateTime direction: DESC GetNetworkConnectionExample: value: pagination: offset: 0 limit: 20 total: 2 data: - href: https://api.equinix.com/fabric/v4/connections/92dc376a-a932-43aa-a6a2-c806dedbd784 type: IP_VC uuid: 9b8c5042-b553-4d5e-a2ac-c73bf6d4fd81 - href: https://api.equinix.com/fabric/v4/connections/38a1eb68-4daf-4ef0-bd7f-6970727b6fc1 type: IP_VC uuid: 38a1eb68-4daf-4ef0-bd7f-6970727b6fc1 400_invalid_uuid: value: - errorCode: EQ-3152004 errorMessage: Invalid inlput correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 details: Network does not exists with gievn uuid NetworkChangeResponseExample: value: pagination: offset: 0 limit: 20 total: 1 data: - href: https://api.equinix.com/fabric/v4/networks/2a4fb415-5a7f-436f-bae6-02f5e403deec/changes/4b17da68-3d6b-436d-9c8f-2105f3b950d9 type: NETWORK_CREATION uuid: 4b17da68-3d6b-436d-9c8f-2105f3b950d9 status: COMPLETED createdDateTime: 2020-05-21T10:30:00Z updatedDateTime: 2020-05-21T10:30:50Z - href: https://api.equinix.com/fabric/v4/networks/2a4fb415-5a7f-436f-bae6-02f5e403deec/changes/da2a2f1b-9ba0-415b-85d6-234bd4c737ec type: NETWORK_DELETION uuid: da2a2f1b-9ba0-415b-85d6-234bd4c737ec status: REQUESTED createdDateTime: 2020-05-21T10:30:00Z updatedDateTime: 2020-05-21T10:30:00Z NetworkGetChangeResponseExample: value: href: https://api.equinix.com/fabric/v4/networks/2a4fb415-5a7f-436f-bae6-02f5e403deec/changes/4b17da68-3d6b-436d-9c8f-2105f3b950d9 type: NETWORK_CREATION uuid: 4b17da68-3d6b-436d-9c8f-2105f3b950d9 status: COMPLETED createdDateTime: 2020-05-21T10:30:00Z updatedDateTime: 2020-05-21T10:30:50Z ntpStandardService: value: type: NTP name: EPT-NTP-Service connections: - uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 package: code: NTP_STANDARD ipv4: primary: 192.168.0.2 secondary: 192.168.0.3 networkMask: 255.255.255.255 defaultGateway: 192.167.0.1 ptpStandardService: value: type: PTP name: EPT-PTP-Service connections: - uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 package: code: PTP_STANDARD ipv4: primary: 192.168.0.2 secondary: 192.168.0.3 networkMask: 255.255.255.255 defaultGateway: 192.167.0.1 order: purchaseOrderNumber: 1-129105284100 ntpEnterpriseService: value: type: NTP name: EPT-NTP-Service connections: - uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 package: code: NTP_ENTERPRISE ipv4: primary: 192.168.0.2 secondary: 192.168.0.3 networkMask: 255.255.255.255 defaultGateway: 192.167.0.1 ptpEnterpriseService: value: type: PTP name: EPT-PTP-Service connections: - uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 package: code: PTP_ENTERPRISE ipv4: primary: 192.168.0.2 secondary: 192.168.0.3 networkMask: 255.255.255.255 defaultGateway: 192.167.0.1 ptpStandardWithAdvancedConfiguration: value: type: PTP name: EPT-PTP-Service connections: - uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 package: code: PTP_STANDARD ipv4: primary: 192.168.0.2 secondary: 192.168.0.3 networkMask: 255.255.255.255 defaultGateway: 192.167.0.1 ptpAdvancedConfiguration: timeScale: true domain: 127 priority1: 0 priority2: 1 logAnnounceInterval: 1 logSyncInterval: -4 logDelayReqInterval: -4 transportMode: UNICAST grantTime: 300 ptpEnterpriseWithAdvancedConfiguration: value: type: PTP name: EPT-PTP-Service connections: - uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 package: code: PTP_ENTERPRISE ipv4: primary: 192.168.0.2 secondary: 192.168.0.3 networkMask: 255.255.255.255 defaultGateway: 192.167.0.1 ptpAdvancedConfiguration: timeScale: true domain: 127 priority1: 0 priority2: 1 logAnnounceInterval: 1 logSyncInterval: -4 logDelayReqInterval: -4 transportMode: UNICAST grantTime: 300 ntpEnterpriseWithAdvancedConfiguration: value: type: NTP name: EPT-NTP-Service connections: - uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 package: code: NTP_ENTERPRISE ipv4: primary: 192.168.0.2 secondary: 192.168.0.3 networkMask: 255.255.255.255 defaultGateway: 192.167.0.1 ntpAdvancedConfiguration: - type: ASCII keyNumber: 65534 key: plain_printable_key - type: HEX keyNumber: 65535 key: a1a1a1a1a1a1a1 ntpStandardCreateResponse: value: href: https://api.equinix.com/fabric/v4/timeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 type: NTP uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 name: EPT-NTP-Service state: PROVISIONING connections: - href: https://api.equinix.com/fabric/v4/connections/06dbb0e3-e55d-4090-8aff-fc5654abaad0 type: EVPL_VC uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 aSide: accessPoint: type: COLO location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY ibx: NY1 zSide: accessPoint: type: SP location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY package: href: https://api.equinix.com/fabric/v4/timeServicePackages/NTP_STANDARD code: NTP_STANDARD ipv4: primary: 192.168.0.2 secondary: 192.168.0.3 networkMask: 255.255.255.255 defaultGateway: 192.167.0.1 account: accountNumber: 123456 changeLog: createdByEmail: abc@xyz.com createdDateTime: 2024-08-24T06:50:46Z updatedByEmail: abc@xyz.com updatedDateTime: 2024-08-24T06:51:46Z ntpEnterpriseCreateResponse: value: href: https://api.equinix.com/fabric/v4/timeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 type: NTP uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 name: EPT-NTP-Service state: PROVISIONING connections: - href: https://api.equinix.com/fabric/v4/connections/06dbb0e3-e55d-4090-8aff-fc5654abaad0 type: EVPL_VC uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 aSide: accessPoint: type: COLO location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY ibx: NY1 zSide: accessPoint: type: SP location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY package: href: https://api.equinix.com/fabric/v4/timeServicePackages/NTP_ENTERPRISE code: NTP_ENTERPRISE ipv4: primary: 192.168.0.2 secondary: 192.168.0.3 networkMask: 255.255.255.255 defaultGateway: 192.167.0.1 ntpAdvancedConfiguration: - type: ASCII keyNumber: 65534 key: plain_printable_key - type: HEX keyNumber: 65535 key: a1a1a1a1a1a1a1 account: accountNumber: 123456 changeLog: createdByEmail: abc@xyz.com createdDateTime: 2024-08-24T06:50:46Z updatedByEmail: abc@xyz.com updatedDateTime: 2024-08-24T06:51:46Z ptpStandardCreateResponse: value: href: https://api.equinix.com/fabric/v4/timeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 type: PTP uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 name: EPT-PTP-Service state: PROVISIONING connections: - href: https://api.equinix.com/fabric/v4/connections/06dbb0e3-e55d-4090-8aff-fc5654abaad0 type: EVPL_VC uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 aSide: accessPoint: type: COLO location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY ibx: NY1 zSide: accessPoint: type: SP location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY package: href: https://api.equinix.com/fabric/v4/timeServicePackages/PTP_STANDARD code: PTP_STANDARD ipv4: primary: 192.168.0.2 secondary: 192.168.0.3 networkMask: 255.255.255.255 defaultGateway: 192.167.0.1 ptpAdvancedConfiguration: timeScale: true domain: 127 priority1: 0 priority2: 1 logAnnounceInterval: 1 logSyncInterval: -4 logDelayReqInterval: -4 transportMode: UNICAST grantTime: 300 account: accountNumber: 123456 changeLog: createdByEmail: abc@xyz.com createdDateTime: 2024-08-24T06:50:46Z updatedByEmail: abc@xyz.com updatedDateTime: 2024-08-24T06:51:46Z ptpEnterpriseCreateResponse: value: href: https://api.equinix.com/fabric/v4/timeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 type: PTP uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 name: EPT-PTP-Service state: PROVISIONING connections: - href: https://api.equinix.com/fabric/v4/connections/06dbb0e3-e55d-4090-8aff-fc5654abaad0 type: EVPL_VC uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 aSide: accessPoint: type: COLO location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY ibx: NY1 zSide: accessPoint: type: SP location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY package: href: https://api.equinix.com/fabric/v4/timeServicePackages/PTP_ENTERPRISE code: PTP_ENTERPRISE ipv4: primary: 192.168.0.2 secondary: 192.168.0.3 networkMask: 255.255.255.255 defaultGateway: 192.167.0.1 ptpAdvancedConfiguration: timeScale: true domain: 127 priority1: 0 priority2: 1 logAnnounceInterval: 1 logSyncInterval: -4 logDelayReqInterval: -4 transportMode: UNICAST grantTime: 300 account: accountNumber: 123456 changeLog: createdByEmail: abc@xyz.com createdDateTime: 2024-08-24T06:50:46Z updatedByEmail: abc@xyz.com updatedDateTime: 2024-08-24T06:51:46Z 400-Invalid-Name: value: - errorCode: EQ-4800010 errorMessage: Validation Error correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 additionalInfo: - property: /name reason: Invalid name provided 400-Validate-Name: value: - errorCode: EQ-4800100 errorMessage: Validation Error correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 additionalInfo: - property: /name reason: The name length should be 3 as minimum. The name should start with characters. Valid characters for a name include letters, numbers, dashes, and underscores 400-Duplicate-Name: value: - errorCode: EQ-4800101 errorMessage: Service name is already in use correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Mandatory-ConnectionUUid: value: - errorCode: EQ-4800011 errorMessage: Mandatory field ConnectionUUid is missing correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Invalid-ConnectionUuid-Format: value: - errorCode: EQ-4800023 errorMessage: Invalid connection uuid format correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Invalid-Connection-Status: value: - errorCode: EQ-4800102 errorMessage: Connection should be in Pending Approval state correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Validate-ConnectionUuid: value: - errorCode: EQ-4800103 errorMessage: Connection does not belong to this user correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Invalid-Connection-Location: value: - errorCode: EQ-4800104 errorMessage: Connection location is not supported by EPT correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Mandatory-PackageType: value: - errorCode: EQ-4800011 errorMessage: Mandatory field Package Type is missing correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Invalid-PackageType: value: - errorCode: EQ-4800010 errorMessage: Invalid Package Type - Allowed types are PTP, NTP correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Invalid-Connection-PackageType: value: - errorCode: EQ-4800105 errorMessage: Connection Package type is different correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Mandatory-Package: value: - errorCode: EQ-4800011 errorMessage: Mandatory field Package is missing correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Invalid-Package: value: - errorCode: EQ-4800010 errorMessage: Invalid Package - Allowed packages are STANDARD, ENTERPRISE correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Invalid-Connection-Package: value: - errorCode: EQ-4800106 errorMessage: Connection Package is different correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Mandatory-PrimaryIP: value: - errorCode: EQ-4800011 errorMessage: Mandatory field PrimaryIP is missing correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Invalid-PrimaryIP-Format: value: - errorCode: EQ-4800023 errorMessage: Invalid PrimaryIP format correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Validate-PrimaryIP: value: - errorCode: EQ-4800107 errorMessage: Invalid PrimaryIP - only range 10.0.0.0 to 10.255.255.255, 172.16.0.0 to 172.31.255.255, 192.168.0.0 to 192.168.255.255 is allowed correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Mandatory-SecondaryIP: value: - errorCode: EQ-4800011 errorMessage: Mandatory field SecondaryIP is missing correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Invalid-SecondaryIP-Format: value: - errorCode: EQ-4800023 errorMessage: Invalid SecondaryIP format correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Validate-SecondaryIP: value: - errorCode: EQ-4800107 errorMessage: Invalid SecondaryIP - only range 10.0.0.0 to 10.255.255.255, 172.16.0.0 to 172.31.255.255, 192.168.0.0 to 192.168.255.255 is allowed correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Validate-SameSubnet: value: - errorCode: EQ-4800108 errorMessage: Primary and Secondary IPs should be in the same subnet correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Mandatory-NetworkMask: value: - errorCode: EQ-4800011 errorMessage: Mandatory field NetworkMask is missing correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Invalid-NetworkMask-Format: value: - errorCode: EQ-4800023 errorMessage: Invalid NetworkMask format correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Validate-NetworkMask: value: - errorCode: EQ-4800109 errorMessage: Invalid NetworkMask - Network mask should not exceed the allowed range of protocol and service tier correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Invalid-DefaultGateway-Format: value: - errorCode: EQ-4800023 errorMessage: Invalid DefaultGateway correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Validate-DefaultGateway: value: - errorCode: EQ-4800110 errorMessage: Invalid DefaultGateway- Default Gateway cannot be same as Primary/Secondary IP correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Invalid-TimeScale: value: - errorCode: EQ-4800010 errorMessage: Invalid TimeScale - Allowed values are ARB, PTP correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Invalid-Domain: value: - errorCode: EQ-4800010 errorMessage: Invalid Domain- Allowed values are from 0 to 127 correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Invalid-Priority1: value: - errorCode: EQ-4800010 errorMessage: Invalid Priority1 - Allowed values are 0 to 248 correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Invalid-Priority2: value: - errorCode: EQ-4800010 errorMessage: Invalid Priority2 - Allowed values are 0 to 248 correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Invalid-LogAnnounceInterval: value: - errorCode: EQ-4800010 errorMessage: Invalid LogAnnounceInterval correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Validate-LogAnnounceInterval-Range: value: - errorCode: EQ-4800111 errorMessage: Invalid LogAnnounceInterval range - Allowed range is -3 to 1 correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Invalid-LogSyncInterval: value: - errorCode: EQ-4800010 errorMessage: Invalid LogSyncInterval correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Validate-LogSyncInterval-Range: value: - errorCode: EQ-4800112 errorMessage: Invalid LogSyncInterval range - Allowed range is -5 to 1 correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Invalid-LogDelayReqInterval: value: - errorCode: EQ-4800010 errorMessage: Invalid logDelayReqInterval correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Validate-LogDelayReqInterval-Range: value: - errorCode: EQ-4800112 errorMessage: Invalid logDelayReqInterval range - Allowed range is -5 to 1 correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Invalid-TransportMode: value: - errorCode: EQ-4800010 errorMessage: Invalid TransportMode - Allowed values are Multicast, Unicast, Hybrid correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Invalid-GrantTime: value: - errorCode: EQ-4800010 errorMessage: Invalid GrantTime correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Validate-GrantTime-Range: value: - errorCode: EQ-4800113 errorMessage: Invalid GrantTime range - Allowed range is 30 to 7200 correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Invalid-Type: value: - errorCode: EQ-4800010 errorMessage: Invalid Type - Allowed values are ASCII, HEX correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Invalid-Id: value: - errorCode: EQ-4800010 errorMessage: Invalid Id - Only Integers are allowed correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Invalid-Password: value: - errorCode: EQ-4800010 errorMessage: Invalid Password correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 400-Validate-Password: value: - errorCode: EQ-4800114 errorMessage: Only HEX allowed, chars value length should between 10 - 40 correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 ntpStandardResponseASidePort: value: href: https://api.equinix.com/fabric/v4/timeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 type: NTP uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 name: EPT-NTP-Service state: PROVISIONED connections: - href: https://api.equinix.com/fabric/v4/connections/06dbb0e3-e55d-4090-8aff-fc5654abaad0 type: EVPL_VC uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 aSide: accessPoint: type: COLO location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY ibx: NY1 zSide: accessPoint: type: SP location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY package: href: https://api.equinix.com/fabric/v4/timeServicePackages/NTP_STANDARD code: NTP_STANDARD ipv4: primary: 192.168.0.2 secondary: 192.168.0.3 networkMask: 255.255.255.255 defaultGateway: 192.167.0.1 order: orderNumber: 1-129105284100 account: accountNumber: 123456 changeLog: createdByEmail: abc@xyz.com createdDateTime: 2024-08-24T06:50:46Z updatedByEmail: abc@xyz.com updatedDateTime: 2024-08-24T06:51:46Z ntpStandardResponseASideVirtualDevice: value: href: https://api.equinix.com/fabric/v4/timeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 type: NTP uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 name: EPT-NTP-Service state: PROVISIONED connections: - href: https://api.equinix.com/fabric/v4/connections/06dbb0e3-e55d-4090-8aff-fc5654abaad0 type: EVPL_VC uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 aSide: accessPoint: type: VD location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY ibx: NY1 zSide: accessPoint: type: SP location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY package: href: https://api.equinix.com/fabric/v4/timeServicePackages/NTP_STANDARD code: NTP_STANDARD ipv4: primary: 192.168.0.2 secondary: 192.168.0.3 networkMask: 255.255.255.255 defaultGateway: 192.167.0.1 order: orderNumber: 1-129105284100 account: accountNumber: 123456 changeLog: createdByEmail: abc@xyz.com createdDateTime: 2024-08-24T06:50:46Z updatedByEmail: abc@xyz.com updatedDateTime: 2024-08-24T06:51:46Z ntpStandardResponseASideCloudRouter: value: href: https://api.equinix.com/fabric/v4/timeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 type: NTP uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 name: EPT-NTP-Service state: PROVISIONED connections: - href: https://api.equinix.com/fabric/v4/connections/06dbb0e3-e55d-4090-8aff-fc5654abaad0 type: IP_VC uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 aSide: accessPoint: type: CLOUD_ROUTER location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY ibx: NY1 zSide: accessPoint: type: SP location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY package: href: https://api.equinix.com/fabric/v4/timeServicePackages/NTP_STANDARD code: NTP_STANDARD ipv4: primary: 192.168.0.2 secondary: 192.168.0.3 networkMask: 255.255.255.255 defaultGateway: 192.167.0.1 order: orderNumber: 1-129105284100 account: accountNumber: 123456 changeLog: createdByEmail: abc@xyz.com createdDateTime: 2024-08-24T06:50:46Z updatedByEmail: abc@xyz.com updatedDateTime: 2024-08-24T06:51:46Z ntpEnterpriseWOMD5ResponseASidePort: value: href: https://api.equinix.com/fabric/v4/timeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 type: NTP uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 name: EPT-NTP-Service state: PROVISIONED connections: - href: https://api.equinix.com/fabric/v4/connections/06dbb0e3-e55d-4090-8aff-fc5654abaad0 type: EVPL_VC uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 aSide: accessPoint: type: COLO location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY ibx: NY1 zSide: accessPoint: type: SP location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY package: href: https://api.equinix.com/fabric/v4/timeServicePackages/NTP_ENTERPRISE code: NTP_ENTERPRISE ipv4: primary: 192.168.0.2 secondary: 192.168.0.3 networkMask: 255.255.255.255 defaultGateway: 192.167.0.1 order: orderNumber: 1-129105284100 account: accountNumber: 123456 changeLog: createdByEmail: abc@xyz.com createdDateTime: 2024-08-24T06:50:46Z updatedByEmail: abc@xyz.com updatedDateTime: 2024-08-24T06:51:46Z ntpEnterpriseResponseASidePort: value: href: https://api.equinix.com/fabric/v4/timeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 type: NTP uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 name: EPT-NTP-Service state: PROVISIONED connections: - href: https://api.equinix.com/fabric/v4/connections/06dbb0e3-e55d-4090-8aff-fc5654abaad0 type: EVPL_VC uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 aSide: accessPoint: type: COLO location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY ibx: NY1 zSide: accessPoint: type: SP location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY package: href: https://api.equinix.com/fabric/v4/timeServicePackages/NTP_ENTERPRISE code: NTP_ENTERPRISE ipv4: primary: 192.168.0.2 secondary: 192.168.0.3 networkMask: 255.255.255.255 defaultGateway: 192.167.0.1 ntpAdvancedConfiguration: - type: ASCII keyNumber: 65534 key: plain_printable_key - type: HEX keyNumber: 65535 key: a1a1a1a1a1a1a1 order: orderNumber: 1-129105284100 account: accountNumber: 123456 changeLog: createdByEmail: abc@xyz.com createdDateTime: 2024-08-24T06:50:46Z updatedByEmail: abc@xyz.com updatedDateTime: 2024-08-24T06:51:46Z ntpEnterpriseResponseASideVirtualDevice: value: href: https://api.equinix.com/fabric/v4/timeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 type: NTP uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 name: EPT-NTP-Service state: PROVISIONED connections: - href: https://api.equinix.com/fabric/v4/connections/06dbb0e3-e55d-4090-8aff-fc5654abaad0 type: EVPL_VC uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 aSide: accessPoint: type: VD location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY ibx: NY1 zSide: accessPoint: type: SP location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY package: href: https://api.equinix.com/fabric/v4/timeServicePackages/NTP_ENTERPRISE code: NTP_ENTERPRISE ipv4: primary: 192.168.0.2 secondary: 192.168.0.3 networkMask: 255.255.255.255 defaultGateway: 192.167.0.1 ntpAdvancedConfiguration: - type: ASCII keyNumber: 65534 key: plain_printable_key - type: HEX keyNumber: 65535 key: a1a1a1a1a1a1a1 order: orderNumber: 1-129105284100 account: accountNumber: 123456 changeLog: createdByEmail: abc@xyz.com createdDateTime: 2024-08-24T06:50:46Z updatedByEmail: abc@xyz.com updatedDateTime: 2024-08-24T06:51:46Z ntpEnterpriseResponseASideCloudRouter: value: href: https://api.equinix.com/fabric/v4/timeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 type: NTP uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 name: EPT-NTP-Service state: PROVISIONED connections: - href: https://api.equinix.com/fabric/v4/connections/06dbb0e3-e55d-4090-8aff-fc5654abaad0 type: IP_VC uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 aSide: accessPoint: type: CLOUD_ROUTER location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY zSide: accessPoint: type: SP location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY package: href: https://api.equinix.com/fabric/v4/timeServicePackages/NTP_ENTERPRISE code: NTP_ENTERPRISE ipv4: primary: 192.168.0.2 secondary: 192.168.0.3 networkMask: 255.255.255.255 defaultGateway: 192.167.0.1 ntpAdvancedConfiguration: - type: ASCII keyNumber: 65534 key: plain_printable_key - type: HEX keyNumber: 65535 key: a1a1a1a1a1a1a1 order: orderNumber: 1-129105284100 account: accountNumber: 123456 changeLog: createdByEmail: abc@xyz.com createdDateTime: 2024-08-24T06:50:46Z updatedByEmail: abc@xyz.com updatedDateTime: 2024-08-24T06:51:46Z ptpStandardResponse: value: href: https://api.equinix.com/fabric/v4/timeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 type: PTP uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 name: EPT-PTP-Service state: PROVISIONED connections: - href: https://api.equinix.com/fabric/v4/connections/06dbb0e3-e55d-4090-8aff-fc5654abaad0 type: EVPL_VC uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 aSide: accessPoint: type: COLO location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY ibx: NY1 zSide: accessPoint: type: SP location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY package: href: https://api.equinix.com/fabric/v4/timeServicePackages/PTP_STANDARD code: PTP_STANDARD ipv4: primary: 192.168.0.2 secondary: 192.168.0.3 networkMask: 255.255.255.255 defaultGateway: 192.167.0.1 order: orderNumber: 1-129105284100 account: accountNumber: 123456 changeLog: createdByEmail: abc@xyz.com createdDateTime: 2024-08-24T06:50:46Z updatedByEmail: abc@xyz.com updatedDateTime: 2024-08-24T06:51:46Z ptpEnterpriseResponse: value: href: https://api.equinix.com/fabric/v4/timeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 type: PTP uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 name: EPT-PTP-Service state: PROVISIONED connections: - href: https://api.equinix.com/fabric/v4/connections/06dbb0e3-e55d-4090-8aff-fc5654abaad0 type: EVPL_VC uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 aSide: accessPoint: type: COLO location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY ibx: NY1 zSide: accessPoint: type: SP location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY package: href: https://api.equinix.com/fabric/v4/timeServicePackages/PTP_ENTERPRISE code: PTP_ENTERPRISE ipv4: primary: 192.168.0.2 secondary: 192.168.0.3 networkMask: 255.255.255.255 defaultGateway: 192.167.0.1 ptpAdvancedConfiguration: timeScale: true domain: 127 priority1: 0 priority2: 1 logAnnounceInterval: 1 logSyncInterval: -4 logDelayReqInterval: -4 transportMode: UNICAST grantTime: 300 order: orderNumber: 1-129105284100 account: accountNumber: 123456 changeLog: createdByEmail: abc@xyz.com createdDateTime: 2024-08-24T06:50:46Z updatedByEmail: abc@xyz.com updatedDateTime: 2024-08-24T06:51:46Z configureStandardService: value: type: NTP name: EPT-Standard-Service connections: - uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 package: code: NTP_STANDARD ipv4: primary: 192.168.0.2 secondary: 192.168.0.3 networkMask: 255.255.255.255 defaultGateway: 192.167.0.1 configureNtpEnterpriseAdvancedConfig: value: type: NTP name: EPT-NTP-Service connections: - uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 package: code: NTP_ENTERPRISE ipv4: primary: 192.168.0.2 secondary: 192.168.0.3 networkMask: 255.255.255.255 defaultGateway: 192.167.0.1 ntpAdvancedConfiguration: - type: ASCII keyNumber: 65534 key: plain_printable_key - type: HEX keyNumber: 65535 key: a1a1a1a1a1a1a1 configurePtpWithAdvancedConfig: value: type: PTP name: EPT-PTP-Service connections: - uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 package: code: PTP_STANDARD ipv4: primary: 192.168.0.2 secondary: 192.168.0.3 networkMask: 255.255.255.255 defaultGateway: 192.167.0.1 ptpAdvancedConfiguration: timeScale: true domain: 127 priority1: 0 priority2: 1 logAnnounceInterval: 1 logSyncInterval: -4 logDelayReqInterval: -4 transportMode: UNICAST grantTime: 300 ntpStandardConfigureResponse: value: href: https://api.equinix.com/fabric/v4/timeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 type: NTP uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 name: EPT-NTP-Service state: PROVISIONING connections: - href: https://api.equinix.com/fabric/v4/connections/06dbb0e3-e55d-4090-8aff-fc5654abaad0 type: EVPL_VC uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 aSide: accessPoint: type: COLO location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY ibx: NY1 zSide: accessPoint: type: SP location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY package: href: https://api.equinix.com/fabric/v4/timeServicePackages/NTP_STANDARD code: NTP_STANDARD ipv4: primary: 192.168.0.2 secondary: 192.168.0.3 networkMask: 255.255.255.255 defaultGateway: 192.167.0.1 account: accountNumber: 123456 order: orderNumber: 1-129105284100 changeLog: createdByEmail: abc@xyz.com createdDateTime: 2024-08-24T06:50:46Z updatedByEmail: abc@xyz.com updatedDateTime: 2024-08-24T06:51:46Z ntpStandardDeletingResponse: value: href: https://api.equinix.com/fabric/v4/timeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 type: NTP uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 name: EPT-NTP-Service state: DEPROVISIONING connections: - href: https://api.equinix.com/fabric/v4/connections/06dbb0e3-e55d-4090-8aff-fc5654abaad0 type: EVPL_VC uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 aSide: accessPoint: type: COLO location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY ibx: NY1 zSide: accessPoint: type: SP location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY package: href: https://api.equinix.com/fabric/v4/timeServicePackages/NTP_STANDARD code: NTP_STANDARD ipv4: primary: 192.168.0.2 secondary: 192.168.0.3 networkMask: 255.255.255.255 defaultGateway: 192.167.0.1 account: accountNumber: 123456 order: orderNumber: 1-216720438646 changeLog: createdByEmail: abc@xyz.com createdDateTime: 2024-08-24T06:50:46Z updatedByEmail: abc@xyz.com updatedDateTime: 2024-08-24T06:51:46Z deletedByEmail: abc@xyz.com deletedDateTime: 2024-08-24T06:52:46Z updateName: value: - op: replace path: /name value: Updated-Service-Name updatePackageCode: value: - op: replace path: /package/code value: NTP_ENTERPRISE updateNetworkInformation: value: - op: replace path: /ipv4 value: primary: 192.168.254.241 secondary: 192.168.254.242 networkMask: 255.255.255.240 defaultGateway: 192.168.254.254 updatePtpAdvancedConfiguration: value: - op: replace path: /ptpAdvancedConfiguration value: timeScale: PTP domain: 20 priority1: 20 priority2: 20 logAnnounceInterval: 1 logSyncInterval: -4 logDelayReqInterval: -4 transportMode: UNICAST grantTime: 300 updateNtpAdvancedConfiguration: value: - op: replace path: /ntpAdvancedConfiguration value: - type: ASCII keyNumber: 65534 key: plain-text-key - type: HEX keyNumber: 65535 key: a1a1a1a1a1a1 ntpStandardReprovisionResponse: value: href: https://api.equinix.com/fabric/v4/timeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 type: NTP uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 name: EPT-NTP-Service state: REPROVISIONING connections: - href: https://api.equinix.com/fabric/v4/connections/06dbb0e3-e55d-4090-8aff-fc5654abaad0 type: EVPL_VC uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 aSide: accessPoint: type: COLO location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY ibx: NY1 zSide: accessPoint: type: SP location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY package: href: https://api.equinix.com/fabric/v4/timeServicePackages/NTP_STANDARD code: NTP_STANDARD ipv4: primary: 192.168.0.2 secondary: 192.168.0.3 networkMask: 255.255.255.255 defaultGateway: 192.167.0.1 account: accountNumber: 123456 order: orderNumber: 1-129105284100 changeLog: createdByEmail: abc@xyz.com createdDateTime: 2024-08-24T06:50:46Z updatedByEmail: abc@xyz.com updatedDateTime: 2024-08-24T06:51:46Z SearchTimeServicesFilterByStatus: value: filter: and: - property: /state operator: = values: - PROVISIONED - property: /project/projectId operator: = values: - "995072000433550" pagination: offset: 0 limit: 20 sort: - direction: DESC property: /changeLog/createdDateTime SearchTimeServicesByNameAndProtocol: value: filter: and: - property: /name operator: = values: - test-service - property: /type operator: = values: - NTP - property: /project/projectId operator: = values: - "995072000433550" pagination: offset: 0 limit: 20 sort: - direction: DESC property: /changeLog/createdDateTime SearchTimeServicesFilterOrAnd: value: filter: and: - or: - property: /uuid operator: LIKE values: - 676a0c3f-a785-4294-87bc-25fe9318a620% - property: /name operator: LIKE values: - test-time-service - property: /project/projectId operator: = values: - "995072000433550" serviceSearchResponse: value: pagination: offset: 20 limit: 20 total: 100 next: /search?offset=40&limit=20 previous: /search?offset=0&limit=20 data: - href: https://api.equinix.com/fabric/v4/timeServices/a8ba52de-faae-43b5-b0b1-6904d37ee011 type: NTP uuid: a8ba52de-faae-43b5-b0b1-6904d37ee011 name: EPT-NTP-STD-Service state: PROVISIONING connections: - href: https://api.equinix.com/fabric/v4/connections/06dbb0e3-e55d-4090-8aff-fc5654abaad0 type: EVPL_VC uuid: 06dbb0e3-e55d-4090-8aff-fc5654abaad0 aSide: accessPoint: type: COLO location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY ibx: NY1 zSide: accessPoint: type: SP location: metroHref: https://api.equinix.com/fabric/v4/metros/NY metroCode: NY package: href: https://api.equinix.com/fabric/v4/timeServicePackages/NTP_STANDARD code: NTP_STANDARD ipv4: primary: 192.168.0.2 secondary: 192.168.0.3 networkMask: 255.255.255.255 defaultGateway: 192.167.0.1 account: accountNumber: 123456 changeLog: createdByEmail: abc@xyz.com createdDateTime: 2024-08-24T06:50:46Z updatedByEmail: abc@xyz.com updatedDateTime: 2024-08-24T06:51:46Z service_400_invalid_sorting: value: - errorCode: EQ-3040039 errorMessage: Invalid value for sorting direction. correlationId: c82ff3bc-de07-47e5-b3ec-53a009d01515 additionalInfo: - reason: Only accept DESC and ASC for sorting direction. serviceConnectionsResponse: value: pagination: offset: 0 limit: 20 total: 2 data: - href: https://api.equinix.com/fabric/v4/connections/92dc376a-a932-43aa-a6a2-c806dedbd784 type: EVPL_VC uuid: 92dc376a-a932-43aa-a6a2-c806dedbd784 - href: https://api.equinix.com/fabric/v4/connections/42dc376a-a932-43aa-a6a2-d806dedbd783 type: EVPL_VC uuid: 42dc376a-a932-43aa-a6a2-d806dedbd783 servicePackagesResponse: value: pagination: offset: 0 limit: 20 total: 4 data: - href: https://api.equinix.com/fabric/v4/timeServicePackages/NTP_STANDARD type: TIME_SERVICE_PACKAGE code: NTP_STANDARD bandwidth: 1 clientsPerSecondMax: 1000 accuracySlaUnit: microseconds accuracySla: -1 accuracySlaMin: 1 accuracySlaMax: 100 redundancySupported: false multiSubnetSupported: false changeLog: createdDateTime: 2023-05-16T07:50:49.749Z updatedDateTime: 2023-05-17T07:50:49.749Z - href: https://api.equinix.com/fabric/v4/timeServicePackages/NTP_ENTERPRISE type: TIME_SERVICE_PACKAGE code: NTP_ENTERPRISE bandwidth: 5 clientsPerSecondMax: 2000 accuracySlaUnit: microseconds accuracySla: -1 accuracySlaMin: 1 accuracySlaMax: 100 redundancySupported: false multiSubnetSupported: true changeLog: createdDateTime: 2023-05-16T07:50:49.749Z updatedDateTime: 2023-05-17T07:50:49.749Z - href: https://api.equinix.com/fabric/v4/timeServicePackages/PTP_STANDARD type: TIME_SERVICE_PACKAGE code: PTP_STANDARD bandwidth: 5 clientsPerSecondMax: 20 accuracySlaUnit: microseconds accuracySla: 50 accuracySlaMin: 1 accuracySlaMax: 10 redundancySupported: false multiSubnetSupported: true changeLog: createdDateTime: 2023-05-16T07:50:49.749Z updatedDateTime: 2023-05-17T07:50:49.749Z - href: https://api.equinix.com/fabric/v4/timeServicePackages/PTP_ENTERPRISE type: TIME_SERVICE_PACKAGE code: PTP_ENTERPRISE bandwidth: 10 clientsPerSecondMax: 100 accuracySlaUnit: microseconds accuracySla: 50 accuracySlaMin: 1 accuracySlaMax: 10 redundancySupported: false multiSubnetSupported: true changeLog: createdDateTime: 2023-05-16T07:50:49.749Z updatedDateTime: 2023-05-17T07:50:49.749Z servicePackageResponse: value: href: https://api.equinix.com/fabric/v4/timeServicePackages/NTP_STANDARD type: TIME_SERVICE_PACKAGE code: NTP_STANDARD bandwidth: 10 clientsPerSecondMax: 100 accuracySlaUnit: microseconds accuracySla: 50 accuracySlaMin: 1 accuracySlaMax: 10 redundancySupported: true multiSubnetSupported: true changeLog: createdDateTime: 2023-05-16T07:50:49.749Z updatedDateTime: 2023-05-17T07:50:49.749Z subscription-response: value: href: https://api.equinix.com/fabric/v4/marketplaceSubscriptions/c5557b51-7938-4f7d-afaa-41b930903a5e uuid: c5557b51-7938-4f7d-afaa-41b930903a5e state: ACTIVE marketplace: AWS offerType: PRIVATE_OFFER isAutoRenew: false offerId: offer-wqquayy2jy25o trial: enabled: true metroCodes: - SV - DC entitlements: - uuid: a15b6b20-b765-4bf7-a661-a3e9372d5435 quantityEntitled: 1 quantityConsumed: 0 quantityAvailable: 1 asset: type: XF_ROUTER package: code: STANDARD - uuid: 2e3a9041-19ce-4c80-add3-3e3a069fc5e9 quantityEntitled: 1 quantityConsumed: 0 quantityAvailable: 1 asset: type: IP_VC bandwidth: 500 - uuid: 9e30f661-d92e-4083-812f-db359807806e quantityEntitled: 1 quantityConsumed: 0 quantityAvailable: 1 asset: type: IPWAN_VC bandwidth: 200 changeLog: createdBy: adminuser createdDateTime: 2020-05-21T10:30:00Z updatedBy: adminuser updatedDateTime: 2020-05-21T10:30:00Z stream-get-all-example: value: pagination: offset: 0 limit: 20 total: 1 data: - href: https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418 uuid: d684aa26-8276-48b7-bb42-a6d9def0a418 type: TELEMETRY_STREAM name: stream 1 description: stream dec 1 project: projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 state: PROVISIONED assetsCount: 1 streamSubscriptionsCount: 2 changeLog: createdDateTime: 2024-05-06T16:21:18.545214Z StreamPostRequestExample: value: type: TELEMETRY_STREAM name: splunk1 description: subscription-1 project: projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 StreamResponseExample: value: href: https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418 uuid: d684aa26-8276-48b7-bb42-a6d9def0a418 type: TELEMETRY_STREAM name: stream1 description: stream 1 project: projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 state: PROVISIONED assetsCount: 1 streamSubscriptionsCount: 2 changeLog: createdDateTime: 2024-05-06T16:21:18.545214Z StreamPutRequestExample: value: name: splunk1 description: subscription 1 StreamDeleteRequestExample: value: href: https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418 uuid: d684aa26-8276-48b7-bb42-a6d9def0a418 type: TELEMETRY_STREAM name: stream1 description: stream 1 project: projectId: dadd3ab6-c0af-430c-8216-43d44f08c1c5 state: DEPROVISIONING assetsCount: 1 streamSubscriptionsCount: 2 changeLog: createdDateTime: 2024-05-06T16:21:18.545214Z StreamAssetSearchRequestExample: value: filter: and: - property: /streamUuid operator: = values: - e684aa26-8276-48b7-bb42-a6d9def0a419 pagination: offset: 0 limit: 20 sort: - direction: DESC property: /uuid stream-asset-get-all-example: value: pagination: offset: 0 limit: 20 total: 1 data: - href: https://api.equinix.com/fabric/v4/ports/e684aa26-8276-48b7-bb42-a6d9def0a419 uuid: d684aa26-8276-48b7-bb42-a6d9def0a418 type: XF_PORT metricsEnabled: false attachmentStatus: ATTACHED StreamConnectionAssetResponseExample: value: href: https://api.equinix.com/fabric/v4/streams/e684aa26-8276-48b7-bb42-a6d9def0a419/connections/d684aa26-8276-48b7-bb42-a6d9def0a418 uuid: d684aa26-8276-48b7-bb42-a6d9def0a418 type: IP_VC metricsEnabled: false attachmentStatus: ATTACHED StreamAssetPutRequestExample: value: metricsEnabled: false StreamRouterAssetAttachResponseExample: value: href: https://api.equinix.com/fabric/v4/streams/e684aa26-8276-48b7-bb42-a6d9def0a419/routers/d684aa26-8276-48b7-bb42-a6d9def0a418 uuid: d684aa26-8276-48b7-bb42-a6d9def0a418 type: XF_ROUTER metricsEnabled: false attachmentStatus: ATTACHING StreamRouterAssetDetachResponseExample: value: href: https://api.equinix.com/fabric/v4/streams/e684aa26-8276-48b7-bb42-a6d9def0a419/routers/d684aa26-8276-48b7-bb42-a6d9def0a418 uuid: d684aa26-8276-48b7-bb42-a6d9def0a418 type: XF_ROUTER metricsEnabled: false attachmentStatus: DETACHING stream-subscription-get-all-example: value: pagination: offset: 0 limit: 20 total: 1 data: - href: https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/subscriptions/d684aa26-8276-48b7-bb42-a6d9def0a418 uuid: d684aa26-8276-48b7-bb42-a6d9def0a418 type: STREAM_SUBSCRIPTION name: splunk description: subscription 1 state: PROVISIONED metricSelector: include: - equinix.fabric.connection.* eventSelector: include: - equinix.fabric.connection.* sink: uri: https://xxxxxx type: SPLUNK_HEC batchEnabled: false batchSizeMax: 50 batchWaitTimeMax: 5 changeLog: createdDateTime: 2024-05-06T16:21:18.545214Z StreamSubscriptionPostRequestExampleSimpleDefaultSplunk: value: type: STREAM_SUBSCRIPTION name: splunk1 description: subscription-1 enabled: true sink: uri: https://xxxxxx type: SPLUNK_HEC credential: type: ACCESS_TOKEN accessToken: Splunk settings: source: Equinix eventIndex: idx-hec-event metricIndex: idx-hec-metric StreamSubscriptionPostRequestExampleSplunk: value: type: STREAM_SUBSCRIPTION name: splunk1 description: subscription-1 enabled: true metricSelector: include: - equinix.fabric.connection.* eventSelector: include: - equinix.fabric.connection.* sink: uri: https://xxxxxx type: SPLUNK_HEC credential: type: ACCESS_TOKEN accessToken: Splunk settings: source: Equinix eventIndex: idx-hec-event metricIndex: idx-hec-metric StreamSubscriptionPostRequestExampleSlack: value: type: STREAM_SUBSCRIPTION name: slack1 description: subscription-1 enabled: true metricSelector: include: - equinix.fabric.connection.* eventSelector: include: - equinix.fabric.connection.* sink: uri: https://xxxxxx type: SLACK StreamSubscriptionPostRequestExamplePagerduty: value: type: STREAM_SUBSCRIPTION name: pagerduty description: subscription-1 enabled: true metricSelector: include: - equinix.fabric.connection.* eventSelector: include: - equinix.fabric.connection.* sink: host: events.pagerduty.com type: PAGERDUTY credential: type: INTEGRATION_KEY integrationKey: my-integration-key settings: changeUri: https://events.pagerduty.com/v2/change/enqueeue alertUri: https://events.pagerduty.com/v2/enqueeue StreamSubscriptionPostRequestExampleDatadog: value: type: STREAM_SUBSCRIPTION name: datadog description: subscription-1 enabled: true metricSelector: include: - equinix.fabric.connection.* sink: host: us.datadoghq.com type: DATADOG credential: type: API_KEY apiKey: my-api-key settings: source: Equinix applicationKey: my-application-key eventUri: https://us.datadoghq.com/api/v1/events metricUri: https://us.datadoghq.com/api/v2/series StreamSubscriptionPostRequestExampleTeams: value: type: STREAM_SUBSCRIPTION name: teams1 description: subscription-1 enabled: true metricSelector: include: - equinix.fabric.connection.* eventSelector: include: - equinix.fabric.connection.* sink: uri: https://xxxxxx type: TEAMS StreamSubscriptionPostRequestExampleServicenow: value: type: STREAM_SUBSCRIPTION name: servicenow-1 description: subscription-1 enabled: true eventSelector: include: - equinix.fabric.connection.* sink: host: https://.com type: SERVICENOW credential: type: USERNAME_PASSWORD username: password: settings: source: Equinix StreamSubscriptionResponseExample: value: href: https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/subscriptions/d684aa26-8276-48b7-bb42-a6d9def0a418 uuid: d684aa26-8276-48b7-bb42-a6d9def0a418 type: STREAM_SUBSCRIPTION name: stream 1 description: stream dec 1 state: PROVISIONED enabled: true metricSelector: include: - equinix.fabric.connection.* eventSelector: include: - equinix.fabric.connection.* sink: uri: https://xxxxxx type: SPLUNK_HEC credential: type: ACCESS_TOKEN accessToken: Splunk settings: source: Equinix eventIndex: idx-hec-event metricIndex: idx-hec-metric batchEnabled: false batchSizeMax: 50 batchWaitTimeMax: 5 changeLog: createdDateTime: 2024-05-06T16:21:18.545214Z StreamSubscriptionPutRequestExample: value: name: splunk1 description: subscription 1 enabled: true metricSelector: include: - equinix.fabric.connection.* eventSelector: include: - equinix.fabric.connection.* sink: uri: https://xxxxxx type: SPLUNK_HEC credential: type: ACCESS_TOKEN accessToken: my-access-token settings: source: Equinix eventIndex: idx-hec-event metricIndex: idx-hec-metric batchEnabled: false batchSizeMax: 50 batchWaitTimeMax: 5 StreamSubscriptionDeleteResponseExample: value: href: https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/subscriptions/d684aa26-8276-48b7-bb42-a6d9def0a418 uuid: d684aa26-8276-48b7-bb42-a6d9def0a418 type: STREAM_SUBSCRIPTION name: stream 1 description: stream dec 1 state: DEPROVISIONING enabled: true metricSelector: include: - equinix.fabric.connection.* eventSelector: include: - equinix.fabric.connection.* sink: uri: https://xxxxxx type: SPLUNK_HEC credential: type: ACCESS_TOKEN accessToken: Splunk settings: source: Equinix eventIndex: idx-hec-event metricIndex: idx-hec-metric batchEnabled: false batchSizeMax: 50 batchWaitTimeMax: 5 changeLog: createdDateTime: 2024-05-06T16:21:18.545214Z stream-alert-rules-get-all-example: value: pagination: offset: 0 limit: 20 total: 1 data: - href: https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/alertRules/0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15 uuid: 0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15 type: METRIC_ALERT name: metric-alert-1 description: metric-alert-1 state: ACTIVE enabled: true metricName: equinix.fabric.connection.bandwidth_tx.usage resourceSelector: include: - "*/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b" windowSize: PT15M operand: ABOVE warningThreshold: 35000000 criticalThreshold: 45000000 changeLog: createdBy: user createdDateTime: 2024-05-06T16:21:18.545214Z StreamAlertRulePostRequestExample: value: type: METRIC_ALERT name: metric-alert-1 description: metric-alert-1 enabled: true metricName: equinix.fabric.connection.bandwidth_tx.usage resourceSelector: include: - "*/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b" operand: ABOVE windowSize: PT15M warningThreshold: 35000000 criticalThreshold: 45000000 StreamAlertRuleResponseExample: value: href: https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/alertRules/0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15 uuid: 0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15 type: METRIC_ALERT name: metric-alert-1 description: metric-alert-1 state: ACTIVE enabled: true metricName: equinix.fabric.connection.bandwidth_tx.usage resourceSelector: include: - "*/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b" windowSize: PT15M operand: ABOVE warningThreshold: 35000000 criticalThreshold: 45000000 changeLog: createdBy: user createdDateTime: 2024-05-06T16:21:18.545214Z updatedBy: user updatedDateTime: 2025-02-04T00:20:54.511118575Z StreamAlertRulePutRequestExample: value: name: metric-alert-1 description: metric-alert-1 enabled: true metricName: equinix.fabric.connection.bandwidth_tx.usage resourceSelector: include: - "*/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b" operand: ABOVE windowSize: PT15M warningThreshold: 35000000 criticalThreshold: 45000000 StreamAlertRuleDeleteResponseExample: value: href: https://api.equinix.com/fabric/v4/streams/d684aa26-8276-48b7-bb42-a6d9def0a418/alertRules/0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15 uuid: 0bbcea48-1333-4ad5-a7ea-e4d58a5fbd15 type: METRIC_ALERT name: metric-alert-1 description: metric-alert-1 state: INACTIVE enabled: true metricName: equinix.fabric.connection.bandwidth_tx.usage resourceSelector: include: - "*/connections/8b140c74-0331-46d1-9cb3-2981be84dd1b" windowSize: PT15M operand: ABOVE warningThreshold: 35000000 criticalThreshold: 45000000 changeLog: createdBy: user createdDateTime: 2024-05-06T16:21:18.545214Z updatedBy: user updatedDateTime: 2025-02-04T00:20:54.511118575Z headers: ETag: description: response header - identifier for a specific version of a resource. schema: type: string securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: JWT